Skip to content

Commit c0a56cc

Browse files
committed
doc: Fix broken link in readme, update publishing steps
1 parent 0a09ce1 commit c0a56cc

2 files changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,4 +216,4 @@ our [suggestions for publishing grammars](./doc/publishing-grammars.md).
216216
## Contributing to Ohm
217217

218218
Interested in contributing to Ohm? Please read [CONTRIBUTING.md](./CONTRIBUTING.md)
219-
and the [Ohm Contributor Guide](doc/contributing.md).
219+
and the [Ohm Contributor Guide](doc/contributor-guide.md).

doc/contributor-guide.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We support all [_Active LTS_ and _Maintenance LTS_ releases][nodejs-releases].
1212

1313
[nodejs-releases]: https://nodejs.dev/en/about/releases/
1414

15-
You also need to install [Yarn 1](https://classic.yarnpkg.com/lang/en/).
15+
You also need to install [pnpm](https://pnpm.io/).
1616

1717
### Basic Setup
1818

@@ -23,30 +23,30 @@ First, clone the repository:
2323
Then, install the dev dependencies:
2424

2525
cd ohm
26-
yarn install
26+
pnpm install
2727

28-
_Note: the `postinstall` script (which is automatically run by `yarn install`)
28+
_Note: the `postinstall` script (which is automatically run by `pnpm install`)
2929
will install a git pre-commit hook. See [here](#pre-commit-checks) for more
3030
information._
3131

3232
### Useful Scripts
3333

3434
The following scripts are useful when developing the main `ohm-js` package:
3535

36-
- Use `yarn test` to run the unit tests.
37-
- `yarn run test-watch` re-runs the unit tests every time a file changes.
38-
- `yarn build` builds `dist/ohm.js` and `dist/ohm.min.js`,
36+
- Use `pnpm test` to run the unit tests.
37+
- `pnpm run test-watch` re-runs the unit tests every time a file changes.
38+
- `pnpm build` builds `dist/ohm.js` and `dist/ohm.min.js`,
3939
which are stand-alone bundles that can be included in a webpage.
4040
- When editing Ohm's own grammar (in `src/ohm-grammar.ohm`), run
41-
`yarn run bootstrap` to re-build Ohm and test your changes.
41+
`pnpm run bootstrap` to re-build Ohm and test your changes.
4242

4343
## Doing Development
4444

4545
See our recommended [Git workflow](https://github.com/ohmjs/ohm/wiki/Git-Workflow).
4646

4747
### Pre-commit Checks
4848

49-
When you run `yarn install` in an Ohm checkout, it will automatically install
49+
When you run `pnpm install` in an Ohm checkout, it will automatically install
5050
a pre-commit hook into `.git/hooks/pre-commit`. Every time you commit to the
5151
repository, the pre-commit script checks that all tests pass, and that the
5252
code passes a lint check. We use [ESLint](http://eslint.org/), which helps
@@ -91,8 +91,10 @@ can use `git commit --no-verify` -- but use this sparingly!
9191

9292
## Publishing
9393

94-
To version and publish the ohm-js package, run the following in the ohm-js directory:
94+
To version and publish the ohm-js package:
9595

96-
yarn version-package
97-
yarn publish
98-
git push && git push --tags
96+
1. Update package.json manually to bump the version number.
97+
2. Make sure the CHANGELOG.md is up to date.
98+
3. Run `pnpm publish`
99+
4. Run `git push && git push --tags`
100+
5. Create a release on GitHub, pasting in the changelog contents.

0 commit comments

Comments
 (0)