Create jekyll-gh-pages.yml #120
Merged
Conversation
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #120 +/- ##
=======================================
Coverage 86.80% 86.80%
=======================================
Files 35 35
Lines 2092 2092
=======================================
Hits 1816 1816
Misses 276 276 ☔ View full report in Codecov by Sentry. |
As a devx developer I want to publish GH Pages for several repositories. The [gh pages documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages) is detailed. The following key points contributed to my decision to add this change: * Currently there a 2 ways to generate GH Pages on a repository. The documentation calls these "sources". One is a manual push; the other uses a special github action deployment workflow. * After June 2024, only the github action source will be used. * Best practice around documentation is that (1) a special github "environment" should be created called "github-pages" and (2) a unique branch "gh-pages" should be created alongside the "main". The environment is a set of rules that limits documentation deployments from specific branches and the unique branch means that "code" and site-documentation are kept separate. Therefore, I created the github-pages environment, the gh-pages branch, and the github action workflow defined in this PR
gavindidrichsen
force-pushed
the
cat_1930_gh_pages
branch
from
8706352 to
cc27200
Compare
Co-authored-by: Jordan Breen <[email protected]>
david22swan
approved these changes
Jun 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
As a devx developer I want to publish GH Pages for several repositories. The gh pages documentation is detailed. The following key points contributed to my decision to add this change:
Therefore, I created the github-pages environment, the gh-pages branch, and the github action workflow defined in this PR