Skip to content

Commit 6196620

Browse files
committed
Improve "Creating a release" section of the README
1 parent 088793a commit 6196620

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -207,12 +207,22 @@ The [Serilog.Sinks.Udp](https://github.com/FantasticFiasco/serilog-sinks-udp) pr
207207

208208
**Serilog.Formatting.Log4Net** uses [MinVer](https://github.com/adamralph/minver) for its versioning, so a tag must exist with the chosen semantic version number in order to create an official release.
209209

210-
1. Create an **[annotated](https://stackoverflow.com/questions/11514075/what-is-the-difference-between-an-annotated-and-unannotated-tag/25996877#25996877)** tag, the (multi-line) message of the annotated tag will be the content of the GitHub release. Markdown can be used.
210+
1. Update the [CHANGELOG](CHANGELOG.md) *Unreleased* section to the chosen version and copy the release notes for step #2.
211211

212-
`git tag --annotate 1.0.0-rc.1`
212+
* Add the release date
213+
* Update the link from `HEAD` to the chosen version
213214

214-
2. [Push the tag](https://stackoverflow.com/questions/5195859/how-do-you-push-a-tag-to-a-remote-repository-using-git/26438076#26438076)
215+
2. Create an **[annotated](https://stackoverflow.com/questions/11514075/what-is-the-difference-between-an-annotated-and-unannotated-tag/25996877#25996877)** tag, the (multi-line) message of the annotated tag will be the content of the GitHub release. Markdown (copied from step #1) should be used.
215216

216-
`git push --follow-tags`
217+
`git tag --annotate 1.0.0-rc.1`
218+
219+
3. [Push the tag](https://stackoverflow.com/questions/5195859/how-do-you-push-a-tag-to-a-remote-repository-using-git/26438076#26438076)
220+
221+
`git push --follow-tags`
217222

218223
Once pushed, the GitHub [Continuous Integration](https://github.com/serilog-contrib/serilog-formatting-log4net/blob/main/.github/workflows/continuous-integration.yml) workflow takes care of building, running the tests, creating the NuGet package, creating the GitHub release and finally publishing the produced NuGet package.
224+
225+
After the NuGet package is succesfully published:
226+
227+
4. Update the `ContractVersion` version in the `Serilog.Formatting.Log4Net.csproj` file to the newly released version.
228+
5. Delete the `ApiCompatBaseline.txt` file if there's one.

0 commit comments

Comments
 (0)