puppetlabs / rspec-puppet

RSpec tests for your Puppet manifests
https://puppetlabs.github.io/rspec-puppet/
MIT License
11 stars 18 forks source link

Set correct source directory for jekyll gh-action page and add {{ site.ur l}} to fix links and styling #123

Open danadoherty639 opened 1 week ago

danadoherty639 commented 1 week ago

Summary

The jekyll gh-pages action "sources" its documentation from the root "/" of the repository however respec-puppet holds its documentation under a sub-directory /docs. This points the action to the correct directory to build the documention from with more advanced configuration options under /docs/config.yml. This PR also fixes the issue with the broken links by using Jekyll's global variable site.url configured in /docs/config.yaml. The default css theming is expected to be served from the default root directory and ours is respec-puppet and the site.url is used to fixed this and serve the css from the correct location.

Related Issues (if any)

Mention any related issues or pull requests.

Checklist

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #123 +/- ## ======================================= Coverage 86.80% 86.80% ======================================= Files 35 35 Lines 2092 2092 ======================================= Hits 1816 1816 Misses 276 276 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

ekohl commented 5 days ago

Any reason you need to use {{ site.url }} instead of {{ site.baseurl }}?

danadoherty639 commented 4 days ago

Any reason you need to use {{ site.url }} instead of {{ site.baseurl }}?

Ive tested this with baseurl but if I remember, it broke the css, I will test this out again this morning before opening the PR