Skip to content

Commit

Permalink
build: add script to generate readme files (#1105)
Browse files Browse the repository at this point in the history
#### Motivation

I want a simplier command to generate the readme files. `npm run docs`
after running `npm run build`

#### Modification

- add a `docs` script

#### Checklist

_If not applicable, provide explanation of why._

- [ ] Tests updated
- [ ] Docs updated
- [ ] Issue linked in Title
  • Loading branch information
paulfouquet authored Oct 10, 2024
1 parent 5352975 commit ff38f04
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:

- name: Generate Readme
run: |
node build/src/readme/readme.generate.js
npm run docs
# Validate no READMEs have been updated
- name: Validate Readme generation
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
},
"scripts": {
"build": "tsc",
"docs": "node build/src/readme/readme.generate.js",
"lint": "npx eslint . --ignore-path .gitignore",
"test": "node --test build/"
},
Expand Down

0 comments on commit ff38f04

Please sign in to comment.