Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

36 lines (27 loc) · 1.34 KB
Raw

Contributing

Building

Build the dist folder

npm run bundle

Running CI Tests

On forked repos the ci.yml workflow will run an publish into a package "ghcr-cleanup-action", it's recommended to change the visability of that package to "private".

Publishing a New Release

This project includes a helper script, script/release 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. 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 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.