Skip to content

Commit

Permalink
chore: update npmignore, and contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaunSHamilton committed Feb 1, 2024
1 parent ab819f6 commit 88b1059
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 3 additions & 2 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -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
29 changes: 2 additions & 27 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

0 comments on commit 88b1059

Please # to comment.