From e06bd3fa5bd94d5141e74e2f09fadd9ab40fc8c4 Mon Sep 17 00:00:00 2001 From: Nick Alteen Date: Thu, 2 Nov 2023 09:34:12 -0400 Subject: [PATCH] Format with prettier --- README.md | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 0ada7b9..ebe33cc 100644 --- a/README.md +++ b/README.md @@ -33,15 +33,13 @@ need to perform some initial setup steps before you can develop your action. > [!NOTE] > > You'll need to have a reasonably modern version of -> [Node.js](https://nodejs.org) handy. If you are using a version manager like -> [`nodenv`](https://github.com/nodenv/nodenv) or -> [`nvm`](https://github.com/nvm-sh/nvm), you can run `nodenv install` in the -> root of your repository to install the version specified in -> [`package.json`](./package.json). Otherwise, 20.x or later should work! -> This template has a `.node-version` file at the root of the repository that -> will be used by `nodenv` or `nvm` to automatically switch to the correct -> version of Node.js when you `cd` into the repository. Additionally, this -> `.node-version` file is used by GitHub Actions in a few CI jobs. +> [Node.js](https://nodejs.org) handy (20.x or later should work!). If you are +> using a version manager like [`nodenv`](https://github.com/nodenv/nodenv) or +> [`nvm`](https://github.com/nvm-sh/nvm), this template has a `.node-version` +> file at the root of the repository that will be used to automatically switch +> to the correct version when you `cd` into the repository. Additionally, this +> `.node-version` file is used by GitHub Actions in any `actions/setup-node` +> actions. 1. :hammer_and_wrench: Install the dependencies @@ -207,14 +205,20 @@ steps: ## Publishing a new release -This project includes a helper script designed to streamline the process of tagging and pushing new releases for GitHub Actions. +This project includes a helper script designed to streamline the process of +tagging and pushing new releases for GitHub Actions. -GitHub Actions allows users to select a specific version of the action to use, based on release tags. Our script simplifies this process by performing the following steps: +GitHub Actions allows users to select a specific version of the action to use, +based on release tags. Our 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 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 latest release tag and provides a regular expression to validate the format of the new tag. - -1. **Tagging the new release:** Once a valid new tag is entered, the script tags the new release. - -1. **Pushing the new tag to the remote:** Finally, the script pushes the new tag to the remote repository. From here, you will need to create a new release in GitHub and users can easily reference the new tag in their workflows. +1. **Retrieving the latest release tag:** The script starts by fetching the most + recent release tag 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 latest release tag + and provides a regular expression to validate the format of the new tag. +1. **Tagging the new release:** Once a valid new tag is entered, the script tags + the new release. +1. **Pushing the new tag to the remote:** Finally, the script pushes the new tag + to the remote repository. From here, you will need to create a new release in + GitHub and users can easily reference the new tag in their workflows.