Skip to content

ci: add docs preview #430

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

Merged
merged 1 commit into from
Jan 23, 2025
Merged

ci: add docs preview #430

merged 1 commit into from
Jan 23, 2025

Conversation

dshemetov
Copy link
Contributor

Checklist

Please:

  • Make sure this PR is against "dev", not "main".
  • Request a review from one of the current epipredict main reviewers:
    dajmcdon.
  • Make sure to bump the version number in DESCRIPTION and NEWS.md.
    Always increment the patch version number (the third number), unless you are
    making a release PR from dev to main, in which case increment the minor
    version number (the second number).
  • Describe changes made in NEWS.md, making sure breaking changes
    (backwards-incompatible changes to the documented interface) are noted.
    Collect the changes under the next release number (e.g. if you are on
    0.7.2, then write your changes under the 0.8 heading).
  • Consider pinning the epiprocess version in the DESCRIPTION file if
    • You anticipate breaking changes in epiprocess soon
    • You want to co-develop features in epipredict and epiprocess

Change explanations for reviewer

Adds /preview-docs command to help with docs review

Magic GitHub syntax to mark associated Issue(s) as resolved when this is merged into the default branch

  • Resolves #{issue number}

@dshemetov dshemetov requested a review from dajmcdon as a code owner January 23, 2025 00:36
@dsweber2 dsweber2 mentioned this pull request Jan 23, 2025
19 tasks
@dajmcdon
Copy link
Contributor

@dshemetov Apologies for my bone-headedness, but how would you suggest that I review this PR? What should I look at?

@dshemetov
Copy link
Contributor Author

dshemetov commented Jan 23, 2025

Well, I suppose it's hard to test without merging into main and trying out the workflow. Otherwise you can see here where I tested it. When one of us comments /preview-docs an action is fired and eventually the bot will give a link to a hosted version of the docs.

@dajmcdon dajmcdon merged commit 604173a into dev Jan 23, 2025
1 check passed
@dshemetov dshemetov deleted the netlify branch January 23, 2025 23:55
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.

2 participants