Skip to content

Commit

Permalink
update DEVGUIDE adding a new step to update the AssemblyVersion attri…
Browse files Browse the repository at this point in the history
…bute
  • Loading branch information
64J0 committed Nov 17, 2024
1 parent bb9060c commit 94e310d
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions DEVGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,25 @@ This documentation must be used as a guide for maintainers and developers for bu
1. `git checkout master`
2. Add a new entry at the top of the RELEASE_NOTES.md with a version and a date.
1. If possible link to the relevant issues and PRs and credit the author of the PRs
3. Create a new commit
3. Update the **AssemblyVersion** attribute at *src/Giraffe.fsproj*, using the same version defined at the RELEASE_NOTES.md.
1. Notice that this can be automated in the future with [ionide/KeepAChangelog](https://github.com/ionide/KeepAChangelog).
4. Create a new commit
1. `git add RELEASE_NOTES.md`
2. `git commit -m "Release 6.0.0-beta001"`. Notice that the pre-release versioning scheme is semantic versioning (SemVer), so each section of the pre-release part is compared separately, and purely-numeric sections are compared as integers. For example, if you eventually release `v6.4.1-alpha-9` and `v6.4.1-alpha-10`, the `alpha-9` version will be ranked higher on Nuget. Keep this in mind and prefer the alphaXXX/betaXXX structure, where XXX are integers starting from 001 to 999. First mentioned at this PR comment: [link](https://github.com/giraffe-fsharp/Giraffe/pull/596#issuecomment-2111097042).
4. Make a new tag
5. Make a new tag
1. `git tag v6.0.0-beta001`
5. Push changes
6. Push changes
1. `git push --atomic origin master v6.0.0-beta001`
6. Create a [new pre-release](https://github.com/giraffe-fsharp/Giraffe/releases) on GitHub
7. Create a [new pre-release](https://github.com/giraffe-fsharp/Giraffe/releases) on GitHub
1. Choose the tag you just pushed
2. Title the pre-release the same as the version
3. Copy the pre-release notes from RELEASE_NOTES.md
4. This will trigger a github action to build and publish the nuget package
7. Do any additional testing or tell certain people to try it out
8. Once satisfied repeat the process but without any alpha/beta/rc suffixes.
8. Do any additional testing or tell certain people to try it out
9. Once satisfied repeat the process but without any alpha/beta/rc suffixes.
1. Run through steps 2-6, creating a **release** instead of a pre-release
9. Tell the internet about it
10. Tell the internet about it
1. Tweet about it
2. Post in F# Slack
3. Post in F# Discord
10. Celebrate 🎉
11. Celebrate 🎉

0 comments on commit 94e310d

Please sign in to comment.