ci: run docurium to create documentation - #4961
Merged
Merged
Conversation
Run docurium as part of the build. The goal of this is to be able to evaluate the documentation in a given pull request; as such, this does not implement any sort of deployment pipeline. This will allow us to download a snapshot of the documentation from the CI build and evaluate the docs for a particular pull request; before it's been merged.
ethomson
force-pushed
the
ethomson/ci_docurium
branch
from
January 26, 2019 17:03
770fcf6 to
ace20c6
Compare
Member
Author
|
The goal here is so that I can get a snapshot of the docs to study the docs for a particular pull request. You can either grab these using the REST API or from the Azure Pipelines website:
I'd love to do something like what docs.microsoft.com does on pull requests, where it spins up a website with the changes for you to review and tears that back down when the PR is merged or abandoned. But that's not in scope here. We'll reevaluate how to automatically generate the gh-pages branch that actually lands on libgit2.org, whether that's using GitHub Actions or a release out of the CI build. |
Member
|
This is really cool. Thanks for working on it, @ethomson! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Run docurium as part of the build. The goal of this is to be able to evaluate the documentation in a given pull request; as such, this does not implement any sort of deployment pipeline.
This will allow us to download a snapshot of the documentation from the CI build and evaluate the docs for a particular pull request; before it's been merged.