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

Fix building mkdocs #900

Merged
merged 7 commits into from May 18, 2024
Merged

Fix building mkdocs #900

merged 7 commits into from May 18, 2024

Conversation

dklimpel
Copy link
Contributor

@dklimpel dklimpel commented May 6, 2024

Checklist
  • make test-all (UNIX) passes. CI will also test this
  • unit and/or integration tests are included (if applicable)
  • documentation is changed or added (if applicable)

Description of change

Fix docs pipeline. Build and deploy docs to branch gh_pages. It has do be enabled in https://github.com/goss-org/goss/settings/pages

@dklimpel dklimpel requested a review from aelsabbahy as a code owner May 6, 2024 21:37
@aelsabbahy
Copy link
Member

aelsabbahy commented May 9, 2024

Thank you for opening up this PR, looks promising.

There were some discussions here on readthedocs vs gh-pages: #856

@noirbizarre any idea why the docs build currently fails?

@dklimpel , let's give @noirbizarre a chance to provide feedback. If we don't get any, I can approve and switch to this approach.

Personal bias, I'm looking for the easiest thing to support.

@dklimpel
Copy link
Contributor Author

dklimpel commented May 9, 2024

Thank you for your feedback.

I didn't realise that the decision had been made in favour of readthedocs.

The reason for the failing CI is:

Error: No file in /home/runner/work/goss/goss matched to [**/requirements.txt or **/pyproject.toml], make sure you have checked out the target repository

The setup python job needs for caching a requirements.txt and not an requirements.pip file.

@dklimpel dklimpel changed the title Build mkdocs to gh-pages Fix building mkdocs May 9, 2024
@aelsabbahy aelsabbahy merged commit 65acc48 into goss-org:master May 18, 2024
2 of 3 checks passed
@dklimpel dklimpel deleted the create_gh_pages branch May 18, 2024 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants