Currently, the way we handle the documentation is pushing manually to the gh-pages branch. I extended our CircleCI configuration so that this is done automatically when a push to master occurs - actually only for the master branch, since the documentation should be kept in sync with it.
To enable pushing, I created a deploy key and gave it write permissions for this repository, then added it to CircleCI here. This should be secure since CircleCI keeps the deploy key safe and does not show it in logs or anything similar. Additionally, the key doesn't have permissions to push to master since it will only push to gh-pages.
tilenmarc
commented
5 years ago
Currently, the way we handle the documentation is pushing manually to the
gh-pagesbranch. I extended our CircleCI configuration so that this is done automatically when a push tomasteroccurs - actually only for the master branch, since the documentation should be kept in sync with it.To enable pushing, I created a deploy key and gave it write permissions for this repository, then added it to CircleCI here. This should be secure since CircleCI keeps the deploy key safe and does not show it in logs or anything similar. Additionally, the key doesn't have permissions to push to
mastersince it will only push togh-pages.