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

Use official actions to publish the API docs #108

Merged
merged 2 commits into from
Aug 11, 2024
Merged

Use official actions to publish the API docs #108

merged 2 commits into from
Aug 11, 2024

Conversation

twm
Copy link
Contributor

@twm twm commented Jul 28, 2024

We can now publish pages directly from actions so I composed two official actions:

I also:

  • Switched the Pages source to GitHub Actions
  • Ticked the "Enforce HTTPS" box
  • Removed the environment protection rule that allowed deploys from the gh-pages branch
  • Unticked the "allow admins to bypass" box, since it appears to have allowed a deploy from this PR to go live (!)

Fixes #98.

@twm twm force-pushed the 98-apidocs branch 2 times, most recently from e95553a to aa3c8b9 Compare July 28, 2024 05:09
@twm twm marked this pull request as ready for review July 28, 2024 05:27
@twm twm requested a review from a team July 28, 2024 05:27
Copy link
Member

@adiroiban adiroiban left a comment

Choose a reason for hiding this comment

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

Thanks. It looks good.

Since the GitHub Pages preview functionality is not yet available, we can't deploy the docs for a PR, like we can on Read The Docs.

I guess that the only option is to merge and check that it worked on trunk.

@twm
Copy link
Contributor Author

twm commented Aug 11, 2024

Thank you again @adiroiban!

@twm twm merged commit 27764c3 into trunk Aug 11, 2024
7 checks passed
@twm twm deleted the 98-apidocs branch August 11, 2024 00:13
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.

apidocs build is failing to publish
2 participants