feat: move away from github-pages gem and add ruby 4 support for docs#5534
Open
G-Rath wants to merge 1 commit into
Open
feat: move away from github-pages gem and add ruby 4 support for docs#5534G-Rath wants to merge 1 commit into
G-Rath wants to merge 1 commit into
Conversation
Collaborator
Author
|
Note I've purposely not really put a lot of attention into the specific versions being used, as I figure the bots can easily take care of bumping to latest once this is landed |
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
1 participant
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.
Based off google/osv-scanner#2588 and #4972
This PR reworks the doc page deployment by removing the github pages gem and deploying using a github actions workflow. This was done to enable support for ruby 4, which is unsupported by github pages. As a result of the docs being deployed by github actions rather than pages, the deployment process for docs has changed, this PR also has an update to the contribution docs to reflect these changes. The github action workflow is set to deploy docs when there is a push to the master branch.
This PR also adds some plugins for Jekyll. These were ones that github pages added automatically, now that we have removed github pages, thee plugins are included here instead.
Once this PR is merged, the "Pages" settings will need to be updated. The build and deployment source will need to be changed to github actions
Closes #4972
Closes #5005