Updated Docs and Website Automation Trigger + Procedures - #1386
Conversation
…te PR when website changes are pushed to master
… builds to occur. Fixed version parsing to primarily be based off of the docs/* or release/* branch (which will probably ultimately be the way we do this). Added additional logging. Changed PR branch naming scheme to be unique so maintenance docs builds can occur and we can build them for older docs versions.
…or both website and docs site to make it clear how to manage the branches for building either one.
…ame before the logs display the env variables
|
From the https://pre-commit.com site "Git hook scripts are useful for identifying simple issues before submission to code review. We run our hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements. By pointing these issues out before code review, this allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks." The pre-commit tests failed for trailing whitespace and typos. @NightOwl888 would you like me to add some documentation on how to install and run prek ? |
PR feedback Co-authored-by: John Bampton <jbampton@users.noreply.github.com>
|
There is still a problem with how it creates the PR that I am tracking down. The first build didn't drop the docs files into the |
…lete andrecreate version directory to ensure that only the docfx content is pushed and stale files and folders are removed. This fixes a subtle copy bug that occurs when the folder doesn't exist that may cause some folders to be copied wrong.
…e to include a monotonic incrementing number at the end so commits can be rebuilt without producing the same branch name.
Updated Docs and Website Automation Trigger + Procedures
Description
This updates the automation for both the docs and website. Ever since the automation has been put in place, it has had to be executed manually. This update fixes the triggers so the automation happens automatically.
Website
The trigger was updated to make the
masterbranch the source of truth for the website. This makes it simpler to manage because any PRs that are submitted to themasterbranch will be built into a PR on thelucenenet-siterepo. Once merged, the changes go live.Docs
The source of truth for any docs release is its corresponding
docs/<version>branch. To update the docs, the updates must either be committed to the docs branch directly and merged tomasteror committed tomasterand cherry-picked onto the docs branch(es). The latter approach is generally more flexible.This updates the trigger to fire automatically when any push is made to the
docs/<version>site that will automatically build the docs site and submit a PR to thelucenenet-repo. Once merged, the changes go live.Docs branches still must be created manually from a release branch, but once pushed, the automation kicks in.
This also corrects the logic so the branch names are uniquely identified by the incoming commit hash so multiple releases can be done on the same docs version.
Procedures
This updates the
documentation.mdfile with a new section for both the docs and website which explain the source of truth for each site, workflows for updating the branches, and outlines some guidelines for how to move changes between branches to update both sites while also working with releases.