Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gradle/issue-management-action
GitHub Action for automation around issue management
https://github.com/gradle/issue-management-action
Last synced: about 1 month ago
JSON representation
GitHub Action for automation around issue management
- Host: GitHub
- URL: https://github.com/gradle/issue-management-action
- Owner: gradle
- Created: 2024-01-11T06:58:36.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-23T13:08:48.000Z (4 months ago)
- Last Synced: 2024-09-26T12:41:16.030Z (about 2 months ago)
- Language: TypeScript
- Size: 647 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Issue Management Action
[](https://github.com/super-linter/super-linter)
[](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml)
[](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml)
[](./badges/coverage.svg)
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](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
```bash
npm install
```
1. :building_construction: Linting code
```bash
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. :building_construction: Package the TypeScript for distribution
```bash
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.
```shell
./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.
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.