Skip to content

Commit

Permalink
Merge PR #642 from knocte/improvePreReleaseVersionNumber
Browse files Browse the repository at this point in the history
* build.fsx,RELEASE.md: improve preRelease version numbers
* {README,RELEASE}.md: merge two releasing guidelines into one
  • Loading branch information
knocte authored Dec 20, 2023
2 parents 1e8d187 + 29b80b6 commit 85de773
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,7 @@ Package | Version

## How to release

1. Update [CHANGELOG.md](./CHANGELOG.md) by adding new entry (`## [X.Y.Z]`) and commit it.
2. Create version tag (`git tag vX.Y.Z`)
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
Please [read the Releasing Guidelines](./RELEASE.md) if you're a maintainer.

## How to contribute

Expand Down
9 changes: 6 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Releasing a new version of FSharpLint

1. Update the [changelog](CHANGELOG.md) since last release and get the changes onto master.
2. Tag the head of master with the version number in the format `vx.x.x` - for example: `v0.20.2`.
3. Push the tag to remote.
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
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
changes since the previous release (ideally one line per PR or commit).
2. Commit and push the change onto master branch, and wait until CI finishes successfully.
3. Tag the head of master with the version number in the format `vx.x.x` - e.g.: `git tag v0.20.4`.
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.

After pushing the tag to remote, the publish pipeline will be kicked off which will:
* Build the package
Expand Down
3 changes: 1 addition & 2 deletions build.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,7 @@ let nugetVersion =
| (_, false) ->
let current = changelog.LatestEntry.NuGetVersion |> SemVer.parse
let bumped = { current with
Minor = current.Minor + 1u
Patch = 0u
Patch = current.Patch + 1u
Original = None
PreRelease = None }
let bumpedBaseVersion = string bumped
Expand Down

0 comments on commit 85de773

Please sign in to comment.