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 GitHub Pages upon successfully-merged PR #252

Merged
merged 6 commits into from
Oct 16, 2023

Conversation

BenjaminPelletier
Copy link
Member

@BenjaminPelletier BenjaminPelletier commented Oct 13, 2023

This PR attempts to autogenerate a GitHub Pages site for this repository featuring (initially) a few of the artifacts generated during CI runs. The approach taken in this PR was generally tested on my personal GitHubPages repo, but I don't know how to effectively test whether it works prior to simply merging this PR.

When this PR is merged, I expect the new ci.yml job will be run when the other jobs complete successfully. The Deploy step should only be executed when committing/merging to the main branch. The result of successfully running the Deploy step is that a new gh-pages branch will be created on this repository and the generated site content will be committed to that branch. This repo does not yet have GitHub Pages enabled, so nothing more will happen initially. After this PR is successfully merged and the CI has successfully run and generated the gh-pages branch, I will enable GitHub pages by linking to the gh-pages branch. After doing that, the next commit/merge to main should cause the site content to actually be published.

Everything in the updated CI is running for the pull request except the final step of the new job (which writes to the gh-pages branch), so I expect this to work when merged.

@BenjaminPelletier BenjaminPelletier marked this pull request as ready for review October 14, 2023 03:38
Copy link
Contributor

@barroco barroco left a comment

Choose a reason for hiding this comment

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

This looks very promising :)

@BenjaminPelletier BenjaminPelletier merged commit 5742e0f into interuss:main Oct 16, 2023
10 checks passed
@BenjaminPelletier BenjaminPelletier deleted the publish-gh-pages branch October 16, 2023 15:58
github-actions bot added a commit that referenced this pull request Oct 16, 2023
* Publish GitHub Pages upon successfully-merged PR

* Exclude github_pages Markdown files from hygiene

* Check out repo before running script

* Specify checkout path

* Attempt to fix artifact folder structure

* Attempt to fix folder structure again 5742e0f
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.

2 participants