Skip to content

Add a check for SemVer compliance to the build #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 25, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions fcs/build.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

open System
open System.IO
open Paket
open Fake.BuildServer
open Fake.Core
open Fake.DotNet
Expand Down Expand Up @@ -111,9 +112,59 @@ Target.create "PublishNuGet" (fun _ ->
)
)

let anchor (path: string) =
System.IO.Path.GetFullPath(Path.Combine(__SOURCE_DIRECTORY__, path))

let bumpMajor (semver: Paket.SemVerInfo) =
{ semver with Major = semver.Major + 1u
Minor = 0u
Patch = 0u }

let bumpMinor (semver: Paket.SemVerInfo) =
{ semver with Minor = semver.Minor + 1u
Patch = 0u }

let bumpPatch (semver: Paket.SemVerInfo) =
{ semver with Patch = semver.Patch + 1u }

let (|WithinRange|OutsideRange|) (leftSemver, (magnitude: SynVer.Version), rightSemver) =
let allowedMin =
match magnitude with
| SynVer.Version.Major -> bumpMajor leftSemver
| SynVer.Version.Minor -> bumpMinor leftSemver
| SynVer.Version.Patch -> bumpPatch leftSemver

if rightSemver < allowedMin || rightSemver < leftSemver then OutsideRange else WithinRange

Target.create "ValidateVersionBump" (fun _ ->
let intendedVersion = Paket.PublicAPI.ParseSemVer release.NugetVersion
let lockfile = Paket.LockFile.LoadFrom "paket.lock"
let refGroup = lockfile.Groups.[Paket.Domain.GroupName "reference"]
let oldPackage = refGroup.Resolution.[Paket.Domain.PackageName "FSharp.Compiler.Service"]
let oldVersion = oldPackage.Version
let oldSurfaceArea = SynVer.SurfaceArea.ofAssembly (System.Reflection.Assembly.LoadFile (anchor "packages/reference/FSharp.Compiler.Service/lib/netstandard2.0/FSharp.Compiler.Service.dll"))
let newSurfaceArea = SynVer.SurfaceArea.ofAssembly (System.Reflection.Assembly.LoadFile (anchor "../artifacts/bin/fcs/Release/netstandard2.0/FSharp.Compiler.Service.dll"))
let (computedVersion, computedMagnitude) = SynVer.SurfaceArea.bump (string oldVersion) oldSurfaceArea newSurfaceArea
let parsedComputedVersion = Paket.PublicAPI.ParseSemVer computedVersion
let apiDiffs = SynVer.SurfaceArea.diff oldSurfaceArea newSurfaceArea |> String.concat "\n"
match oldVersion, computedMagnitude, intendedVersion with
| WithinRange ->
Trace.tracefn "Version %A is within the allowed range of %A from the prior version of %A" intendedVersion computedMagnitude oldVersion
| OutsideRange ->
failwithf """Version bump invalid.
Version packaged was %A
Version computed due to API diffs was %A
Allowed version magnitude change is %A
The full set of API diffs is:
%A
""" intendedVersion parsedComputedVersion computedMagnitude apiDiffs
)

// --------------------------------------------------------------------------------------
// Run all targets by default. Invoke 'build <Target>' to override



Target.create "Start" ignore
Target.create "Release" ignore
Target.create "GenerateDocs" ignore
Expand All @@ -140,6 +191,7 @@ open Fake.Core.TargetOperators

"Build"
==> "NuGet"
==> "ValidateVersionBump"
==> "PublishNuGet"
==> "Release"

Expand Down
12 changes: 11 additions & 1 deletion fcs/paket.dependencies
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ nuget Fake.Core.UserInput
nuget Fake.DotNet.Cli
nuget Fake.DotNet.Fsi
nuget Fake.DotNet.Paket
nuget SynVer.FAKE
nuget Paket.Core

group generate

Expand All @@ -27,4 +29,12 @@ nuget Fake.Core
nuget Fake.IO.FileSystem
nuget Fake.Core.Trace
nuget FSharp.Literate 4.0.0-alpha03
nuget FSharp.Formatting 4.0.0-alpha03
nuget FSharp.Formatting 4.0.0-alpha03

group reference

source https://api.nuget.org/v3/index.json
framework: netstandard2.0

storage: packages
nuget FSharp.Compiler.Service 34.1.0
Loading