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

Update pkgdown actions based on branch reorganization #383

Merged
merged 6 commits into from
Jan 4, 2024

Conversation

brookslogan
Copy link
Contributor

@brookslogan brookslogan commented Nov 30, 2023

Goal is to have separate main & dev documentation sites, with different styling, like cmu-delphi/epidatr. Plus some miscellaneous small updates thrown in. [Before, we only would run pkgdown checks on PRs to dev, not render&update the actual site on pushes to dev, since it would clobber the main version of the site.]

Also, remove references to defunct/never-existing `master` branch.
Copy link
Contributor

@nmdefries nmdefries left a comment

Choose a reason for hiding this comment

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

The DESCRIPTION file on dev needs a 4-component version number (x.x.x.x) to trigger the dev-site behavior. Without this, the dev site will keep overwriting the main public version. The main version needs to be a 3-component number (x.x.x). Some more info and links in this PR.

4-component versions complicates automated version bumping, if that's set up in this repo. That will need to be addressed in any workflow files, or noted in any instructions for manual releases.

Recommend including info somewhere about how this works on the public site and how to generate local previews. This is the text I included for developers of epidatr.

_pkgdown.yml Outdated Show resolved Hide resolved
@dshemetov
Copy link
Contributor

This seems like a good PR to bump our package version to dev release. Could you change the version to 0.7.0.9000?

@dshemetov
Copy link
Contributor

Ah I see the version bump happened in #377

Co-authored-by: nmdefries <[email protected]>
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.

should be good to go after #385

@brookslogan
Copy link
Contributor Author

Thanks @dshemetov for addressing the issues. Are we still missing release process documentation as mentioned by @nmdefries? If so, should we put that in another Issue or handle it here?

@dshemetov
Copy link
Contributor

dshemetov commented Nov 30, 2023

Fine to handle it here.

@dsweber2 dsweber2 added this to the Epiprocess Issue Triage milestone Dec 6, 2023
@brookslogan brookslogan mentioned this pull request Dec 11, 2023
@dshemetov dshemetov merged commit e40d02a into dev Jan 4, 2024
2 checks passed
@dshemetov dshemetov deleted the lcb/update-actions-and-pkgdown branch January 4, 2024 18:59
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.

5 participants