Skip to content
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

Add AssemblyVersion attribute #629

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
20 changes: 11 additions & 9 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.
1. Run through steps 2-6, creating a **release** instead of a pre-release
9. Tell the internet about it
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-7, creating a **release** instead of a pre-release
10. Tell the internet about it
1. Tweet about it
2. Post in F# Slack
3. Post in F# Discord
10. Celebrate 🎉
11. Celebrate 🎉
1 change: 1 addition & 0 deletions src/Giraffe/Giraffe.fsproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<PropertyGroup>
<!-- General -->
<AssemblyName>Giraffe</AssemblyName>
<AssemblyVersion>7.0.2</AssemblyVersion>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another potential fix would be to define this property at the dotnet pack command on CI here https://github.com/giraffe-fsharp/Giraffe/blob/master/.github/workflows/publish.yml#L69

<Description>A native functional ASP.NET Core web framework for F# developers.</Description>
<Copyright>Copyright 2020 Dustin Moris Gorski</Copyright>
<Authors>Dustin Moris Gorski and contributors</Authors>
Expand Down
Loading