From 3baa5f1c7b0fa746ce3866de32aeada386ca8d1e Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi <568794+Link-@users.noreply.github.com> Date: Thu, 29 Jan 2026 01:58:05 -0800 Subject: [PATCH] Update contribution docs --- CONTRIBUTING.md | 2 +- RELEASES.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9cfb0a..5164e98 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Please note that this project is released with a [Contributor Code of Conduct][c 1. [Fork][fork] and clone the repository 2. Configure and install the dependencies: `npm install` 3. Make sure the tests pass on your machine: `npm run test` -4. Create a new branch: `git checkout -b my-branch-name` +4. Create a new branch: `git switch -c my-branch-name` 5. Make your change, add tests, and make sure the tests still pass 6. Push to your fork and [submit a pull request][pr] 7. Pat your self on the back and wait for your pull request to be reviewed and merged. diff --git a/RELEASES.md b/RELEASES.md index 7fe3e1b..9c5cd13 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1,5 +1,27 @@ # Releases +## How to prepare a release + +The below is relevant for maintainers with write access only. + +1. Switch to a new branch from `main`. +1. Run `npm test` to ensure all tests are passing. +1. Update the version in [`package.json`](package.json). +1. Run `npm run build` to update the compiled files. +1. Update this [`RELEASES.md`](RELEASES.md) with the new version and changes in the `## Changelog` section. +1. Run `licensed cache` to update the license report. +1. Run `licensed status` and resolve any warnings by updating the [`.licensed.yml`](.licensed.yml) file with the exceptions. +1. Commit your changes and push your branch upstream. +1. Open a pull request against `main` and get it reviewed and merged. +1. Draft a new release https://github.com/actions/cache/releases use the same version number used in `package.json` + 1. Create a new tag with the version number. + 1. Auto generate release notes and update them to match the changes you made in `RELEASES.md`. + 1. Toggle the set as the latest release option. + 1. Publish the release. +1. Navigate to https://github.com/actions/cache/actions/workflows/release-new-action-version.yml + 1. There should be a workflow run queued with the same version number. + 1. Approve the run to publish the new version and update the major tags for this action. + ## Changelog ### 5.0.3