Skip to content

Commit 85de773

Browse files
authored
Merge PR fsprojects#642 from knocte/improvePreReleaseVersionNumber
* build.fsx,RELEASE.md: improve preRelease version numbers * {README,RELEASE}.md: merge two releasing guidelines into one
2 parents 1e8d187 + 29b80b6 commit 85de773

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,7 @@ Package | Version
4949

5050
## How to release
5151

52-
1. Update [CHANGELOG.md](./CHANGELOG.md) by adding new entry (`## [X.Y.Z]`) and commit it.
53-
2. Create version tag (`git tag vX.Y.Z`)
54-
3. Push the tag to the repo `git push origin vX.Y.Z` - this will start CI process that will create a GitHub release and publish the packages to NuGet
52+
Please [read the Releasing Guidelines](./RELEASE.md) if you're a maintainer.
5553

5654
## How to contribute
5755

RELEASE.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Releasing a new version of FSharpLint
22

3-
1. Update the [changelog](CHANGELOG.md) since last release and get the changes onto master.
4-
2. Tag the head of master with the version number in the format `vx.x.x` - for example: `v0.20.2`.
5-
3. Push the tag to remote.
3+
1. Update the [changelog](CHANGELOG.md) since last release: choose a version that increases the Major or Minor part of the version by 1, or the Revision
4+
part of the version by 2, e.g.: `0.20.2` -> `0.23.0` or `0.20.2` -> `1.0` or `0.20.2` -> `0.20.4`, and add the entry (`## [X.Y.Z]`) summarizing all the
5+
changes since the previous release (ideally one line per PR or commit).
6+
2. Commit and push the change onto master branch, and wait until CI finishes successfully.
7+
3. Tag the head of master with the version number in the format `vx.x.x` - e.g.: `git tag v0.20.4`.
8+
4. Push the tag to remote: `git push origin vX.Y.Z` - this will start CI process that will create a GitHub release and publish the packages to NuGet.
69

710
After pushing the tag to remote, the publish pipeline will be kicked off which will:
811
* Build the package

build.fsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,7 @@ let nugetVersion =
7676
| (_, false) ->
7777
let current = changelog.LatestEntry.NuGetVersion |> SemVer.parse
7878
let bumped = { current with
79-
Minor = current.Minor + 1u
80-
Patch = 0u
79+
Patch = current.Patch + 1u
8180
Original = None
8281
PreRelease = None }
8382
let bumpedBaseVersion = string bumped

0 commit comments

Comments
 (0)