From 88b1059d8351119e7d8df6a45f9cc8c6c0b44afa Mon Sep 17 00:00:00 2001 From: Shaun Hamilton Date: Thu, 1 Feb 2024 13:19:41 +0200 Subject: [PATCH] chore: update npmignore, and contributing --- .github/workflows/release.yml | 4 ++-- .npmignore | 5 +++-- docs/src/contributing.md | 29 ++--------------------------- 3 files changed, 7 insertions(+), 31 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 67347493..bbca11af 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -12,9 +12,9 @@ jobs: uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 - name: Publish to NPM - uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3 + uses: actions/setup-node@v4 with: - node-version: 18 + node-version: 20 registry-url: 'https://registry.npmjs.org' - run: npm ci diff --git a/.npmignore b/.npmignore index 0c26ff96..8dc92d0f 100644 --- a/.npmignore +++ b/.npmignore @@ -1,19 +1,20 @@ -.devcontainer # Included, because it helps with testing when importing straight from GitHub # .freeCodeCamp/client .freeCodeCamp/tests # .freeCodeCamp/tsconfig.json # .freeCodeCamp/webpack.config.cjs +.devcontainer .github +.vscode cli docs self - .editorconfig .gitignore .gitpod.yml .prettierignore .prettierrc +CONTRIBUTING.md Dockerfile renovate.json diff --git a/docs/src/contributing.md b/docs/src/contributing.md index 1c2e1d23..c2602a83 100644 --- a/docs/src/contributing.md +++ b/docs/src/contributing.md @@ -102,33 +102,8 @@ cli$ cargo run ### Release -Releases are done automatically on pushes to the `prod` branch. - -```admonish note title=" " -The CI script will fail, if the `version` in `package.json` is not incremented, or the `package.json` and `package-lock.json` are out of sync. -``` +Releases are done manually through the GitHub Actions. #### Making a Release -1. Checkout the `upstream/prod` branch: - -```bash -git fetch --all -git checkout remotes/upstream/prod -``` - -2. Merge the `main` branch into `prod`: - -```bash -git merge remotes/upstream/main -``` - -```admonish info title=" " -Or, you can merge any specific commits from `main` into `prod`. -``` - -3. Push the `prod` branch: - -```bash -git push upstream prod -``` +In the `Actions` tab, select the `Publish to npm` workflow. Then, select `Run workflow`.