Set correct source directory for jekyll gh-pages action #122
Conversation
This file contains 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
gavindidrichsen
temporarily deployed
to
github-pages
GitHub Actions
Inactive
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #122 +/- ##
=======================================
Coverage 86.80% 86.80%
=======================================
Files 35 35
Lines 2092 2092
=======================================
Hits 1816 1816
Misses 276 276 ☔ View full report in Codecov by Sentry. |
ekohl
suggested changes
Jul 1, 2024
There was a problem hiding this comment.
I don't think I have merge permissions here, but I'd urge you to make the git commit summary more concrete. For example, Set correct source directory for jekyll gh-pages action is clearer. Especially when you go through an old project it's better than having 10 "fix jekyll gh-pages action" commits because 10 different things were broken over the years.
gavindidrichsen
changed the title
The default jekyll gh-pages action "sources" its documentation from the root "/" of the repository; however, the `rspec-puppet` has its documentation root beneath "/docs/". In other words, the "/docs/" directory contains more advanced jekyll configuration like a "/docs/_config.yml" and a "/docs/_includes/" directory. This PR fixes the gh-pages deployment. See https://puppetlabs.github.io/rspec-puppet/ for latest documentation Signed-off-by: Gavin Didrichsen <[email protected]>
gavindidrichsen
force-pushed
the
cat_1930_fix_ghpages
branch
from
f08ce63
to
0517a5b
Compare
david22swan
approved these changes
Jul 1, 2024
|
@jordanbreen28 : Thanks for spotting the broken links. I'm investigating now so moving this back to draft. |
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
The default jekyll gh-pages action "sources" its documentation from the root "/" of the repository; however, the
rspec-puppethas its documentation root beneath "/docs/". In other words, the "/docs/" directory contains more advanced jekyll configuration like a "/docs/_config.yml" and a "/docs/_includes/" directory. This PR fixes the gh-pages deployment.See https://puppetlabs.github.io/rspec-puppet/ for latest documentation
Related Issues (if any)
Mention any related issues or pull requests.
Checklist