Skip to content

Commit 86da7df

Browse files
committed
Split README.md into README.md + MAINTENANCE.md
1 parent 9becf8f commit 86da7df

File tree

2 files changed

+23
-24
lines changed

2 files changed

+23
-24
lines changed

MAINTENANCE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Creating a release
2+
3+
**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.
4+
5+
1. Update the [CHANGELOG](CHANGELOG.md) *Unreleased* section to the chosen version and copy the release notes for step #2.
6+
7+
- Add the release date
8+
- Update the link from `HEAD` to the chosen version
9+
10+
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.
11+
12+
`git tag --annotate 1.0.0-rc.1`
13+
14+
3. [Push the tag](https://stackoverflow.com/questions/5195859/how-do-you-push-a-tag-to-a-remote-repository-using-git/26438076#26438076)
15+
16+
`git push --follow-tags`
17+
18+
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.
19+
20+
After the NuGet package is succesfully published:
21+
22+
4. Update the `ContractVersion` version in the `Serilog.Formatting.Log4Net.csproj` file to the newly released version.
23+
5. Delete the `ApiCompatBaseline.txt` file if there's one.

README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -202,27 +202,3 @@ Combining these three enrichers will produce a log event including `thread`, `do
202202
The [Serilog.Sinks.Log4Net](https://github.com/serilog/serilog-sinks-log4net) project is similar but depends on the log4net NuGet package whereas Serilog.Formatting.Log4Net does not. Also, Serilog.Sinks.Log4Net is a sink so you have to configure log4net in addition to configuring Serilog.
203203

204204
The [Serilog.Sinks.Udp](https://github.com/FantasticFiasco/serilog-sinks-udp) project also provides a [Log4Net formatter](https://github.com/FantasticFiasco/serilog-sinks-udp/blob/v7.1.0/src/Serilog.Sinks.Udp/Sinks/Udp/TextFormatters/Log4netTextFormatter.cs) but it writes XML *manually* (without using an [XmlWriter](https://docs.microsoft.com/en-us/dotnet/api/System.Xml.XmlWriter)), completely ignores Serilog properties, is not configurable at all (indentation, newlines, namespaces etc.) and is not documented.
205-
206-
## Creating a release
207-
208-
**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.
209-
210-
1. Update the [CHANGELOG](CHANGELOG.md) *Unreleased* section to the chosen version and copy the release notes for step #2.
211-
212-
* Add the release date
213-
* Update the link from `HEAD` to the chosen version
214-
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.
216-
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`
222-
223-
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)