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

Set correct source directory for jekyll gh-pages action #122

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gavindidrichsen
Copy link

@gavindidrichsen gavindidrichsen commented Jul 1, 2024

Summary

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

Related Issues (if any)

Mention any related issues or pull requests.

Checklist

Copy link

codecov bot commented Jul 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.80%. Comparing base (2c8b9cf) to head (0517a5b).

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.
📢 Have feedback on the report? Share it here.

@gavindidrichsen gavindidrichsen marked this pull request as ready for review July 1, 2024 13:13
@gavindidrichsen gavindidrichsen requested review from bastelfreak and a team as code owners July 1, 2024 13:13
Copy link

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

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 gavindidrichsen changed the title Fix jekyll gh-pages action Set correct source directory for jekyll gh-pages action Jul 1, 2024
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 <gavin.didrichsen@gmail.com>
Copy link

@danadoherty639 danadoherty639 left a comment

Choose a reason for hiding this comment

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

LGTM

@gavindidrichsen gavindidrichsen marked this pull request as draft July 1, 2024 15:42
@gavindidrichsen
Copy link
Author

@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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants