Issue Management Action

This is an action for automation around issue management. Maintained by the Gradle Build Tool Support team.

Initial Setup

After you've cloned the repository to your local machine or codespace, you'll 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 handy (20.x or later should work!). If you are using a version manager like nodenv or 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. 🛠️ Install the dependencies

   npm install
   

2. 🏗️ Linting code

   npm run lint
   

Note: to mute unwanted formatting violations, use:

// prettier-ignore

for prettier/prettier violations and

// eslint-disable-next-line %rule name%

for others.

1. 🏗️ Package the TypeScript for distribution

   npm run bundle
   

Publishing a new release

This project includes a helper script designed to streamline the process of tagging and pushing new releases for GitHub Actions.

./script/release

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.
2. 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.
3. Tagging the new release: Once a valid new tag is entered, the script tags
   the new release.
4. 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.