From 6590bf4e0c73cc55af055b69209099c1499a3f8a Mon Sep 17 00:00:00 2001 From: Paul Ebose Date: Mon, 1 Jul 2024 17:11:32 +0100 Subject: [PATCH] update Publishing a New Release docs --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 928f679..8d5b3e7 100644 --- a/README.md +++ b/README.md @@ -218,15 +218,16 @@ based on release tags. This script simplifies this process by performing the following steps: 1. **Retrieving the latest release tag:** The script starts by fetching the - most recent release tag of the current branch, by looking at the local data - available in your repository. + most recent semver release tag of the current branch, by looking at the + local data available in your repository. 1. **Prompting for a new release tag:** The user is then prompted to enter a new release tag. To assist with this, the script displays the tag retrieved in the previous step, and validates the format of the inputted tag (vX.X.X). The user is also reminded to update the version field in package.json. 1. **Tagging the new release:** The script then tags a new release and syncs - the separate major tag with the new release. When the user is creating a new - major release, the script auto-detects that and creates a `releases/v#` - branch for the previous major version. + the separate major tag (e.g. v1, v2) with the new release tag + (e.g. v1.0.0, v2.1.2). When the user is creating a new major release, the + script auto-detects this and creates a `releases/v#` branch for the previous + major version. 1. **Pushing changes to remote:** Finally, the script pushes the necessary commits, tags and branches to the remote repository.