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

Publish dev-docs with Github Pages artifacts (2nd attempt) #10892

Merged
merged 5 commits into from
Jan 2, 2024
Merged

Conversation

BD103
Copy link
Member

@BD103 BD103 commented Dec 6, 2023

Supersedes #10888.

Objective

Closes #10821

Solution

Notes

  • I made this workflow possible to run through dispatch (workflow_dispatch), in case something goes wrong.
  • I restricted the permissions to just the things Github Pages needs.
  • I made it so that only one deployments can happen at a time, the other deployment requests will be queued up and the latest one will be run.

I'm getting a permissions error when trying to publish the docs. I'm hoping downgrading will fix it.
@alice-i-cecile alice-i-cecile added A-Build-System Related to build systems or continuous integration C-Enhancement A new feature C-Docs An addition or correction to our documentation labels Dec 6, 2023
@alice-i-cecile alice-i-cecile changed the title Publish docs with Github Pages artifacts (2nd attempt) Publish dev-docs with Github Pages artifacts (2nd attempt) Dec 6, 2023
@BD103
Copy link
Member Author

BD103 commented Dec 15, 2023

@mockersf would you mind reviewing this PR?

Comment on lines +21 to +24
# Only allow one deployment to run at a time, however it will not cancel in-progress runs.
concurrency:
group: "pages"
cancel-in-progress: false
Copy link
Member

Choose a reason for hiding this comment

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

why this choice? Cancelling would make sense here, we only care about the last version

Copy link
Member Author

Choose a reason for hiding this comment

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

In the example for using pages artifacts, the following comment is provided about the concurrency setting:

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.

My best guess is that perhaps cancelling the deploy job while it's still uploading to Github pages could be bad, but I've never tested it. (See docs on concurrency.)

I think it would be best to leave this. The developer docs don't seem like a time-sensitive thing. If this is a risk of messing up Github pages, I don't think it's worth the couple of extra minutes saved.

Copy link
Member

Choose a reason for hiding this comment

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

Not a fan of adding that for now, but it doesn't really matter

@BD103
Copy link
Member Author

BD103 commented Jan 1, 2024

Thank you! Could you please make sure to switch the GitHub pages setting for the repo so it uses the artifact when this gets merged?

@BD103
Copy link
Member Author

BD103 commented Jan 2, 2024

@alice-i-cecile could you please review this? (Thanks!)

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 2, 2024
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jan 2, 2024
Merged via the queue into bevyengine:main with commit 1a2a184 Jan 2, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation C-Enhancement A new feature S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish docs with pages artifact
3 participants