Skip to content

Commit 5831f25

Browse files
authored
Merge pull request #1149 from json-api-dotnet/notes-how-to-release
Added notes on how to create a new release
2 parents 4c5d065 + 4181d4e commit 5831f25

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

.github/CONTRIBUTING.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,23 @@ public sealed class AppDbContext : DbContext
8888
}
8989
```
9090

91+
## Creating a release (for maintainers)
92+
93+
- Verify documentation is up-to-date
94+
- Bump the package version in Directory.Build.props
95+
- Create a GitHub release
96+
- Update https://github.com/json-api-dotnet/JsonApiDotNetCore.MongoDb to consume the new version and release
97+
- Create a new branch in https://github.com/json-api-dotnet/MigrationGuide and update README.md in master
98+
9199
## Backporting and hotfixes (for maintainers)
92100

93101
- Checkout the version you want to apply the feature on top of and create a new branch to release the new version:
94102
```
95103
git checkout tags/v2.5.1 -b release/2.5.2
96104
```
97105
- Cherrypick the merge commit: `git cherry-pick {git commit SHA}`
98-
- Bump the package version in the csproj
99-
- Make any other compatibility, documentation or tooling related changes
106+
- Bump the package version in Directory.Build.props
107+
- Make any other compatibility, documentation, or tooling related changes
100108
- Push the branch to origin and verify the build
101109
- Once the build is verified, create a GitHub release, tagging the release branch
102110
- Open a PR back to master with any other additions

0 commit comments

Comments
 (0)