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.

Sign up for GitHub

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

Jump to bottom

Have CircleCI run sbt mdoc + paradox when anything in "/site" folder is changed in a PR #3151

Closed
clairemcginty opened this issue Jul 10, 2020 · 1 comment · Fixed by #3392
Closed

Have CircleCI run sbt mdoc + paradox when anything in "/site" folder is changed in a PR #3151

clairemcginty opened this issue Jul 10, 2020 · 1 comment · Fixed by #3392
Labels
documentation enhancement New feature or request good first issue Good for newcomers

Comments

@clairemcginty
Copy link
Contributor

Changes to any of the markdown files in /site could cause sbt site/mdoc to fail if a code snippet is incorrect, or sbt site/paradox to fail if a @ref link is broken or something. Maybe we could the CircleCI "when" clause: https://circleci.com/docs/2.0/configuration-reference/#the-when-step-requires-version-21 to execute these commands if any site files are in the git diff?

It would also be nice to have CircleCI push the site to GH pages when the PR is merged, but the credentialing might be an issue
@regadas
Copy link
Contributor

regadas commented Sep 30, 2020

@RustedBones will take this one! Thank you!

@RustedBones RustedBones mentioned this issue Oct 9, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Integrate docs in CI RustedBones/scio
3 participants
@regadas @nevillelyh @clairemcginty