X Tutup
The Wayback Machine - https://web.archive.org/web/20200708160820/https://github.com/shelljs/shelljs/issues/918
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

Refactor how we enforce doc generation #918

Open
nfischer opened this issue Dec 2, 2018 · 0 comments
Open

Refactor how we enforce doc generation #918

nfischer opened this issue Dec 2, 2018 · 0 comments
Labels

Comments

@nfischer
Copy link
Member

@nfischer nfischer commented Dec 2, 2018

The gendocs step in Travis generally leads to hard-to-interpret error output. We should consider ways to make this clearer. It's also a bit fragile, because it false-positives whenever any git file is modified, not just when a contributor forgot to generate docs.

Ideas:

  • Change this step to be a bit stricter, and only check if README.md is modified
  • Rewrite this as a unit test, which fails if README.md is poorly formatted
  • Refactor the gendocs script into a function which returns the correct README text. Running in script mode would actually modify the README in-place.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.
X Tutup