Set correct source directory for jekyll gh-pages action

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-pages action #122

Open gavindidrichsen opened 1 week ago

gavindidrichsen commented 1 week ago

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

[x] Manually verified. See https://puppetlabs.github.io/rspec-puppet/

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 (0517a5b).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #122 +/- ## ======================================= 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.

gavindidrichsen commented 1 week ago

@jordanbreen28 : Thanks for spotting the broken links. I'm investigating now so moving this back to draft.