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.

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

Add GitHub token support to documentation scripts #99

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

froschdesign
Copy link
Member

@froschdesign froschdesign commented May 23, 2024

The scripts for processing documentation, including build.sh, update_mkdocs.yml, entrypoint.sh, and deploy.sh, have been updated to support passing a GitHub token. This addition enhances security and access control in documentation builds and deploys.

The token is required to fetch releases from a GitHub repository: https://pygithub.readthedocs.io/en/stable/github_objects/Repository.html#github.Repository.Repository.get_releases

The scripts for processing documentation, including build.sh, update_mkdocs.yml, entrypoint.sh, and deploy.sh, have been updated to support passing a GitHub token. This addition enhances security and access control in documentation builds and deploys.

Signed-off-by: Frank Brückner <[email protected]>
Copy link
Member

@gsteel gsteel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@froschdesign froschdesign marked this pull request as draft August 1, 2024 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants