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

Add docs tests #294

Merged
merged 6 commits into from
Jul 1, 2024
Merged

Add docs tests #294

merged 6 commits into from
Jul 1, 2024

Conversation

Archmonger
Copy link
Owner

@Archmonger Archmonger commented Jul 1, 2024

Summary by Sourcery

Introduced a CI workflow to automate the testing of documentation builds and link checks, ensuring the integrity of documentation on a regular basis.

  • CI:
    • Added a new GitHub Actions workflow to test documentation builds and link checks on push, pull request, and a daily schedule.

Copy link

sourcery-ai bot commented Jul 1, 2024

Reviewer's Guide by Sourcery

This pull request introduces a new GitHub Actions workflow to automate the testing of documentation. The workflow is triggered on pushes and pull requests to the main branch, as well as on a daily schedule. It includes steps to check out the repository, set up Python, and verify the documentation build and links.

File-Level Changes

Files Changes
.github/workflows/test-docs.yml Introduced a new GitHub Actions workflow to automate the testing of documentation, including link checks and documentation build verification.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Archmonger - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 3 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

.github/workflows/test-docs.yml Outdated Show resolved Hide resolved
.github/workflows/test-docs.yml Outdated Show resolved Hide resolved
.github/workflows/test-docs.yml Outdated Show resolved Hide resolved
Archmonger and others added 5 commits July 1, 2024 01:33
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@Archmonger Archmonger changed the title add docs tests Add docs tests Jul 1, 2024
@Archmonger Archmonger merged commit 64eed9e into main Jul 1, 2024
6 checks passed
@Archmonger Archmonger deleted the add-initial-docs-tests branch July 1, 2024 08:56
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.

1 participant