Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix readme build #1459

Merged
merged 8 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 --quiet 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
Loading