From 4181d4e9c9d5e7ce514189613d3c568d86d38fd7 Mon Sep 17 00:00:00 2001 From: Bart Koelman <10324372+bkoelman@users.noreply.github.com> Date: Wed, 6 Apr 2022 05:23:18 +0200 Subject: [PATCH] Added notes on how to create a new release --- .github/CONTRIBUTING.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0d51d15e75..150c8b45df 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -88,6 +88,14 @@ public sealed class AppDbContext : DbContext } ``` +## Creating a release (for maintainers) + +- Verify documentation is up-to-date +- Bump the package version in Directory.Build.props +- Create a GitHub release +- Update https://github.com/json-api-dotnet/JsonApiDotNetCore.MongoDb to consume the new version and release +- Create a new branch in https://github.com/json-api-dotnet/MigrationGuide and update README.md in master + ## Backporting and hotfixes (for maintainers) - Checkout the version you want to apply the feature on top of and create a new branch to release the new version: @@ -95,8 +103,8 @@ public sealed class AppDbContext : DbContext git checkout tags/v2.5.1 -b release/2.5.2 ``` - Cherrypick the merge commit: `git cherry-pick {git commit SHA}` -- Bump the package version in the csproj -- Make any other compatibility, documentation or tooling related changes +- Bump the package version in Directory.Build.props +- Make any other compatibility, documentation, or tooling related changes - Push the branch to origin and verify the build - Once the build is verified, create a GitHub release, tagging the release branch - Open a PR back to master with any other additions