From 83e53b297ba20ee7f1eeacab71a6bb89a4fbdd2c Mon Sep 17 00:00:00 2001 From: wh1337 <11448029+wh1337@users.noreply.github.com> Date: Mon, 28 Aug 2023 19:25:19 -0400 Subject: [PATCH] updated release.md (@toddb) --- RELEASE.md | 51 ++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 40 insertions(+), 11 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 39a1697..bcef94d 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,21 +1,50 @@ -# Releasing a new Version +# Creating releases Releases are triggered via a GitHub Action. In order for this Action to be triggered, a new release must be made via the UI in GitHub. -## Current Process +Main Conventions: + +- product releases are versioned via X.X.X (eg 0.1.0) +- tags have prefix 'v' (eg v0.1.0) + +NOTE: The `v` prefix is required. The GitHub Action will not trigger withouth it. + +## Step One: making changes and merging + +All deployments should take place from the `main` branch. To release a new feature branch, you will need to create a PR to the main branch from another branch or fork, have it reviewed and merged. - Merge this new change back into `main` -- Navigate to Releases, Draft a new Release -- Create a new tag with the name `v1.0.0`. - - NOTE: The `v` prefix is required. The GitHub Action will not trigger withouth it. -- The release title should be the same name as the new tag created -- Enter your release notes -- Check the `Set as the latest release` box and publish release + +## Step Two: drafting + +- Navigate to [Releases](https://github.com/novuhq/novu-dotnet/releases) +- [Draft a new Release](https://github.com/novuhq/novu-dotnet/releases/new) +- Create a new tag + - Choose a tag > Find or crate a new tag > vX.X.X > Create new tag +- Create release + - Release title: `vX.X.X` + - Content (example): + +``` +## What's Changed +* Nothing functionality from 0.3.1—had a problem in the build scripts for publishing to nuget + + +**Full Changelog**: https://github.com/novuhq/novu-dotnet/compare/vX.X.last)...vX.X.latest) +``` + +- [x] Set as the latest release +- Save as draft [ready for others to review] + +## Step Three: releasing From here, GitHub Actions will trigger and publish the new release to Nuget. It generally takes around 5-10 minutes for the release to run and be available on Nuget. -## How to release a new Feature branch +- open your draft in [releases](https://github.com/novuhq/novu-dotnet/releases) +- Publish release + +## Step Four: post-release checks -All deployments should take place from the `main` branch. To release a new feature branch, you will need to create a PR to the main branch, have it reviewed and merged. Once merged into the -main branch, you will follow the `Current Process` section to release a new version. +- Check that it exists on nuget +- Ideally update a project that uses the version