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

Fix CI status by moving docs deployment to GHA #2358

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

janbrasna
Copy link

Currently the CircleCI secrets only have read-only access scope for the GitHub token, being unable to write the built docs to gh-pages branch. It's the only failure in the pipeline, and instead of providing write permissions it may be easier to just move the actual docs deployment to GitHub Actions, avoiding any commits to the pages' branch and publishing straight to the deployment env without any underlying git tree being written etc.

This PR keeps the docs-build step in CI for consistency in testing, only removing the actual docs-publish and creating a workflow here instead.

Note

To enable Pages publishing via Actions, you may need to to change the publishing source in repo settings for this workflow to take over, and also make sure if there are any env protections defined they also include "master" and not "gh-pages" only.)

Once you're happy with the trigger-based deploys from master, you can safely remove the gh-pages branch completely (which hasn't received updates for more than two years) as it won't be used anymore, and also remove the tschaub/gh-pages yarn dev dependency and relevant scripts as all docs will be published from master branch deploys automatically from that point on.

@janbrasna
Copy link
Author

janbrasna commented Aug 20, 2024

You can check the sample run for b05d1a6 ^^ logged from the fork.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant