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

exclude auto-generated contents from docs/index.md; closes #3713 #3734

Closed
wants to merge 2 commits into from

Conversation

wanseob
Copy link
Contributor

@wanseob wanseob commented Feb 16, 2019

Description of the Change

  • Remove auto-generated contents from docs/index.md
  • Make docs/index.md keep excluding auto-generated contents
    1. At the pre-processing stage, copy docs/index.md to docs/index.md.tmp
    2. Trap exit signals and recover docs/index.md with docs/index.md.tmp after the script execution
  • Add docs/index.md.tmp to the .gitignore list

Benefits

No more frustrating jobs after npm start docs.

Applicable issues

This PR handles #3713

@outsideris outsideris added the area: documentation anything involving docs or mochajs.org label Feb 16, 2019
@coveralls
Copy link

coveralls commented Feb 16, 2019

Coverage Status

Coverage increased (+0.03%) to 91.713% when pulling 7af00e2 on wanseob:issue/3713 into 22831c5 on mochajs:master.

* Remove auto-generated contents from docs/index.md
* Make documents from temporally copied file docs/index.md.tmp
* Add docs/index.md.tmp to the .gitignore list
Copy link
Contributor

@boneskull boneskull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. This removes the auto-generated content, but the idea would be that the content is generated as part of the build process. It looks like you're halfway there--just need to ensure the temporary file is processed by the docs.preprocess script(s).

@boneskull boneskull added the semver-patch implementation requires increase of "patch" version number; "bug fixes" label Feb 27, 2019
@boneskull
Copy link
Contributor

@wanseob I've resolved the conflicts and rebased this branch onto master.

@wanseob
Copy link
Contributor Author

wanseob commented Mar 1, 2019

Appreciate your feedback and rebasing @boneskull. I added a new commit to remove the tmp file at the post-processing step. But I'm wondering that isn't it enough to exit with code 0 when it executes md-magic --config ./scripts/markdown-magic.config.js --path docs/index.md.tmp to ensure. If not, how can we ensure elevanty processed docs/index.md.tmp?

@JoshuaKGoldberg
Copy link
Member

👋 coming back to this @wanseob, are you still interested in working on this PR? As of #5027 there are again maintainers who can review it now. No worries if you no longer have time - but if you do that'd be great!

@JoshuaKGoldberg
Copy link
Member

Closing out to keep our queue small. Someone please yell at me if this should be re-opened though. Cheers! 🤎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org semver-patch implementation requires increase of "patch" version number; "bug fixes"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants