actions
/
typescript-action
Template
mirror of https://github.com/actions/typescript-action.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update Publishing a New Release docs

This commit is contained in:
Paul Ebose 2024-07-01 17:11:32 +01:00
parent d393e547d0
commit 6590bf4e0c
No known key found for this signature in database
GPG Key ID: 2FF647AADFAC0FE8
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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.