Tweak npm scripts #1197
Tweak npm scripts #1197
Conversation
✅ Deploy Preview for pihole-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Can be squashed when merging. |
yubiuser
force-pushed
the
xmr/npm-scripts
branch
from
4fd4afe to
b1b945a
Compare
| @@ -16,11 +16,12 @@ | |||
| }, | |||
| "homepage": "https://docs.pi-hole.net/", | |||
| "scripts": { | |||
| "build": "mkdocs build --clean", | |||
| "build": "mkdocs build --clean --strict", | |||
There was a problem hiding this comment.
Just for the sake of documentation: --strict determines how warnings are handled. Set to halt processing when a warning is raised. Otherwise, print a warning and continue processing.
There was a problem hiding this comment.
I took this from the CI config https://github.com/pi-hole/docs/blob/master/.github/workflows/ci.yml#L44
| "markdownlint": "markdownlint-cli2 \"**/*.md\" \"!**/node_modules/**\"", | ||
| "linkinator": "npm run build && linkinator site --recurse --silent --skip \"^(?!http://localhost)\"", |
There was a problem hiding this comment.
Is it still working when we remove the build step here? I'm asking because when we run npm run test locally before committing/pushing, where does it run the necessary build step?
There was a problem hiding this comment.
Well, no. You need to build the docs manually.
Alternatively, we could just change the CI script if you prefer that.
* add `--strict` in the mkdocs build like on CI * add a `start` script to run serve (can be used with `npm start`) * move `build` to `pretest` As a result, build runs once on CI now
XhmikosR
force-pushed
the
xmr/npm-scripts
branch
from
6ae15f0 to
d843b5f
Compare
Now CI runs build once.
Draft until #1194 is sorted.Thank you for your contribution to the Pi-hole Community!
Please read the comments below to help us consider your Pull Request.
We are all volunteers and completing the process outlined will help us review your commits quicker.
Please make sure you
What does this PR aim to accomplish?:
How does this PR accomplish the above?:
Link documentation PRs if any are needed to support this PR:
By submitting this pull request, I confirm the following:
git rebase)