From db1c463e05c87f65a1da26368fb4f6639406da0a Mon Sep 17 00:00:00 2001 From: Fernandez Ludovic Date: Sun, 9 Feb 2025 03:07:48 +0100 Subject: [PATCH] docs: move dev information into contribution guide --- .github/CONTRIBUTING.md => CONTRIBUTING.md | 18 ++++++++++++++++++ README.md | 18 ------------------ 2 files changed, 18 insertions(+), 18 deletions(-) rename .github/CONTRIBUTING.md => CONTRIBUTING.md (71%) diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 71% rename from .github/CONTRIBUTING.md rename to CONTRIBUTING.md index f740410..9d465bf 100644 --- a/.github/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,3 +23,21 @@ * Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +## Development of this action + +1. Install [act](https://github.com/nektos/act#installation) +2. Make a symlink for `act` to work properly: `ln -s . golangci-lint-action` +3. Install dependencies: `npm install` +4. Build: `npm run build` +5. Run `npm run local` after any change to test it + +### Releases + +```bash +npm version -m "Upgrade to %s" +``` + +- https://docs.npmjs.com/cli/v11/commands/npm-version + +The "major tag" (ex: `v6`) should be deleted and then recreated manually. diff --git a/README.md b/README.md index 3316e2e..be93de9 100644 --- a/README.md +++ b/README.md @@ -539,21 +539,3 @@ Inside our action, we perform 3 steps: GitHub matches keys by prefix if we have no exact match for the primary cache. This scheme is basic and needs improvements. Pull requests and ideas are welcome. - -## Development of this action - -1. Install [act](https://github.com/nektos/act#installation) -2. Make a symlink for `act` to work properly: `ln -s . golangci-lint-action` -3. Install dependencies: `npm install` -4. Build: `npm run build` -5. Run `npm run local` after any change to test it - -### Releases - -```bash -npm version -m "Upgrade to %s" -``` - -- https://docs.npmjs.com/cli/v11/commands/npm-version - -The "major tag" (ex: `v6`) should be deleted and then recreated manually.