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

GitHub pages always deploys latest version #34

Open
tomjemmett opened this issue Mar 8, 2021 · 3 comments
Open

GitHub pages always deploys latest version #34

tomjemmett opened this issue Mar 8, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@tomjemmett
Copy link
Member

The pkgdown action always deploys latest version of master branch, but this will often not reflect what is deployed to cran.

Options:

  1. we should only deploy when a new tag is generated (for a release),
  2. we should indicate clearly that this is the latest version available on GitHub, not all features will be in the cran release,
  3. we should start using a development branch, we only push changes to master when we are ready to submit to cran

Option 2 would get my vote as it's the easiest to implement and most pragmatic.

@tomjemmett tomjemmett added the documentation Improvements or additions to documentation label Mar 8, 2021
@chrismainey
Copy link
Collaborator

This depends on whether we want to use a 'proper' branching structure e.g. GitFlow with a development branch that only merges to main for a release (like 3), or whether we use the 'working' version number that works with pkgdown, with 9999 on the end. You can turn it off with that then. Would mean that I deploy to cran on release, then immediately commit a ..9999 version to put repo in 'development.'

@tomjemmett
Copy link
Member Author

I would probably vote for latter rather than gitflow, that feels a little too over the top for this project

@chrismainey
Copy link
Collaborator

OK, will release via CRAN then switch repo to development mode, and make sure it's explicit on the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants