actions/typescript-action
Template
2
0
Fork 0
mirror of https://github.com/actions/typescript-action.git synced 2025-04-05 14:59:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix spacing in readme

Browse Source
This commit is contained in:
Paul Ebose
2024-08-09 15:09:09 +01:00
parent b2199d3033
commit 95dd9a459e
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -217,19 +217,19 @@ GitHub Actions allows users to select a specific version of the action to use,
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 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 (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. **Retrieving the latest release tag:** The script starts by fetching the 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 (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. From here, you will
need to create a new release in GitHub so users can easily reference the
new tags in their workflows.
commits, tags and branches to the remote repository. From here, you will need
to create a new release in GitHub so users can easily reference the new tags
in their workflows.