Mimblewimble applied in the base layer. Scarce, censorship resistant, durable, indestructible, salable, portable, fungible, private & divisible. Good money.
Proposal to automate mwc-node (API) Crate Documentation generated by rustdocs/Cargo doc
Preamble:
It would be nice to automatically push new API Docs of the Node to Git Pages aswell. This was requested by @vek-kal
This can be accomplished by using an additional build step in Azure pipelines which creates the Docs, and then pushes them to the Gitpages Repo.
This PR has no Impact on Consensus or any actual Code that is connected to the Node itself.
But it does hook into the CI Build process as its own Build Job, so it shouldn't matter if it would fail.
Therefore the impact should be minimal.
If there are any questions or Inputs, please don't hesitate to give me a Tag @bayk.
Also take your time reviewing this as there is no haste to Push API docs out.
Approach/workflow:
Execute Cargo Doc Command to generate Docs (only for API)
Clone current Git Pages Repo into extra Directory
Copy over Changed Docs (overwrite git pages repo locally)
Push Commit back to Git Pages Repo
Check if Github Pages Build was succesfull (so this check will fail if there is an Issue with Docs)
Im not totally sure if this check would actually get this step to fail (its the last command executed, returns a 200 code if AOK)
Step 5 might be unnecessarry/ineffective as Im not sure how long it takes for the build status to be returned.
Needed actions to implement this PR/workflow:
Create PAT for user with push access to mwcproject.github.io
Save this personal Access token as a secret variable in Azure (named 'github_pat')
(might not be needed) explicitly add the PAT user as a member to the mwcproject.github.io Repository where our Gitpages reside
Merge this PR and check if it build successfully upon next release
Explanations of added Values:
ghpages_user: 'mwcproject'(User of Github Pages Repository - the organization account)
ghpages_repo: 'mwcproject.github.io' (Github Pages Repository - that pushed code will be pushed and then availlable via http at mwcproject.github.io)
ghpages_auth_header: '$(echo -n "${gh_user}:$(github_pat)" | base64);'(This is needed to query the Github API to check if the Pages actually rendered.)
Proposal to automate mwc-node (API) Crate Documentation generated by rustdocs/Cargo doc
Preamble:
It would be nice to automatically push new API Docs of the Node to Git Pages aswell. This was requested by @vek-kal This can be accomplished by using an additional build step in Azure pipelines which creates the Docs, and then pushes them to the Gitpages Repo.
This PR has no Impact on Consensus or any actual Code that is connected to the Node itself. But it does hook into the CI Build process as its own Build Job, so it shouldn't matter if it would fail. Therefore the impact should be minimal.
If there are any questions or Inputs, please don't hesitate to give me a Tag @bayk. Also take your time reviewing this as there is no haste to Push API docs out.
Approach/workflow:
Needed actions to implement this PR/workflow:
Create PAT for user with push access to mwcproject.github.io
Save this personal Access token as a secret variable in Azure (named 'github_pat')
(might not be needed) explicitly add the PAT user as a member to the mwcproject.github.io Repository where our Gitpages reside
Merge this PR and check if it build successfully upon next release
Explanations of added Values:
ghpages_user: 'mwcproject'(User of Github Pages Repository - the organization account)ghpages_repo: 'mwcproject.github.io'(Github Pages Repository - that pushed code will be pushed and then availlable via http at mwcproject.github.io)ghpages_auth_header: '$(echo -n "${gh_user}:$(github_pat)" | base64);'(This is needed to query the Github API to check if the Pages actually rendered.)Remarks
If there is an Issue building croaring-sys-mw then this may help https://github.com/mimblewimble/grin/issues/1189#issuecomment-403578676 Im quite sure this was an Issue isolated to my OS tho.
Sources:
https://florian-rappl.de/News/Page/383/azure-pipelines-publish-to-github-pages https://xaviergeerinck.com/post/infrastructure/deploying-gh-pages-with-azure-pipelines/ https://github.com/thebillkidy/thebillkidy.github.io/blob/development/azure-pipelines.yml
If there are any questions, remarks or Feedback feel free to address those, Greetings MrT ☕