Skip to content

Commit

Permalink
Fix readme build (#1459)
Browse files Browse the repository at this point in the history
  • Loading branch information
martijnversluis authored Nov 26, 2024
1 parent a33ba15 commit 5448221
Show file tree
Hide file tree
Showing 11 changed files with 163,492 additions and 3,668 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ jobs:
- name: Install node modules
run: yarn install
- name: Verify README.md
run: yarn unibuild readme && git diff --quiet README.md
run: yarn readme && git diff README.md
verify-install:
runs-on: ubuntu-latest
strategy:
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ src/normalize_mappings/suffix-normalize-mapping.ts
src/parser/chord/combined_grammer.pegjs
src/parser/chord/suffix_grammar.pegjs
src/parser/chord_pro/sections_grammar.pegjs
tmp
2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

yarn unibuild build readme
yarn readme
git add README.md
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ I love receiving pull requests from everyone! Please read this short document be
### `README.md`

Are you trying to make changes to `README.md`? Wait! `README.md` is a auto-generated file.
- to make changes in the first part, go to [docs/README.hbs](docs/README.hbs)
- to make changes in the first part, go to [INTRO.md](INTRO.md)
- the api docs are generated from JSdoc comment embedded in the code, so changing those
comments will result in API doc changes.

When your changes are complete, be sure to run `yarn readme` to regenerate `README.md` and commit the updated `README.md` _together_ with the `README.hbs` changes and/or API doc changes.
When your changes are complete, be sure to run `yarn readme` to regenerate `README.md` and commit the updated `README.md` _together_ with the `INTRO.md` changes and/or API doc changes.

## Pull request guidelines

Expand Down
2 changes: 0 additions & 2 deletions doc/README.hbs → INTRO.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,5 +360,3 @@ use those to change the generated output.

Note: all classes, methods and constants that are documented here can be considered public API and will only be
subject to breaking changes between major versions.

{{>main}}
Loading

0 comments on commit 5448221

Please sign in to comment.