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

Support public and dev docs site #215

Merged
merged 6 commits into from
Nov 14, 2023

Conversation

nmdefries
Copy link
Contributor

@nmdefries nmdefries commented Nov 13, 2023

#213 keeps the doc website updated, but it matches dev rather than any CRAN release. If people go from CRAN to our documentation, they're going to see docs for a version they don't have. However, we'd also like to be able to see a preview of the dev version of the docs.

pkgdown lets you build doc websites from both releases and development branches. This PR turns on that feature, and publishes the doc site on push/pull to both main (reinstated to commit 0adb796, when CRAN-SUBMISSION was changed last) and dev. The dev site will be available at https://cmu-delphi.github.io/epidatr/dev; main/public at https://cmu-delphi.github.io/epidatr.

The dev website must be build from a version with 4 components (e.g. 1.1.1.1). I've added .9000 to the version number on dev to meet that requirement, but we'll need to remove it as part of the release process, since main needs to have a 3-part version number.

@nmdefries nmdefries marked this pull request as ready for review November 14, 2023 16:38
Copy link
Contributor

@dshemetov dshemetov left a comment

Choose a reason for hiding this comment

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

Excellent, thanks Nat! Really appreciate your documentation in DEVELOPMENT.md too.

Copy link
Contributor

@dsweber2 dsweber2 left a comment

Choose a reason for hiding this comment

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

oh, good to know! Needing a 4 point versioning system seems like wild overkill; maybe we could use this pkgdown instead? Up to you as the one actually implementing this.

@nmdefries
Copy link
Contributor Author

Given that the pkgdown action seems pretty unpopular/unknown, let's go with the existing implementation for now. We'll see if it makes the release process too burdensome when that happens next. (That is also manual at the moment; an automated or semi-automated release process would be able to handle the 3<->4 component version switching by itself.)

@nmdefries nmdefries merged commit 4235c9d into dev Nov 14, 2023
@nmdefries nmdefries deleted the ndefries/support-public-and-dev-docs-site branch November 14, 2023 23:17
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.

3 participants