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

Docs workflow - build and check links on PRs #1915

Merged
merged 2 commits into from
Jan 31, 2024

Conversation

ADBond
Copy link
Contributor

@ADBond ADBond commented Jan 31, 2024

Type of PR

  • BUG
  • FEAT
  • MAINT
  • DOC

Is your Pull Request linked to an existing Issue or Pull Request?

Closes #1914, as mooted in this comment.

Give a brief description for the solution you have provided

In documentation workflow splits deploy job into build (which also checks links) and deploy jobs.

Workflow runs on pushes to master (as before), and on PRs into master (in which case deploy does not run). PR version only runs if relevant files have changed.

See examples of the PR version (with no deploy) in this PR - versions which pass and fail link checking. Here is a run coming from 'push' (that includes the deploy job running).

PR Checklist

  • Added documentation for changes
  • Added feature to example notebooks or tutorial (if appropriate)
  • Added tests (if appropriate)
  • Updated CHANGELOG.md (if appropriate)
  • Made changes based off the latest version of Splink
  • Run the linter

@ADBond ADBond added documentation Improvements or additions to documentation continuous integration labels Jan 31, 2024
@ADBond ADBond requested a review from RossKen January 31, 2024 15:08
Copy link
Contributor

@RossKen RossKen left a comment

Choose a reason for hiding this comment

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

This is great - thanks for sorting! 🙌

@ADBond ADBond merged commit 88f407e into moj-analytical-services:master Jan 31, 2024
2 checks passed
@ADBond ADBond deleted the docs-workflow-on-PRs branch January 31, 2024 16:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
continuous integration documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs workflow - build + check links on PRs
2 participants