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

[DOC] Release notes should mention when a release is not published on CRAN #159

Closed
tbouffard opened this issue Nov 24, 2022 · 0 comments · Fixed by #178
Closed

[DOC] Release notes should mention when a release is not published on CRAN #159

tbouffard opened this issue Nov 24, 2022 · 0 comments · Fixed by #178
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@tbouffard
Copy link
Member

tbouffard commented Nov 24, 2022

NOTE: this will apply after the first CRAN publishing, see #10

The CRAN policies state (see https://r-pkgs.org/release.html#cran-policies and https://cran.r-project.org/web/packages/policies.html)

Submitting updates should be done responsibly and with respect for the volunteers’ time. Once a package is established (which may take several rounds), “no more than every 1–2 months” seems appropriate.

However, on our side, we can provide more frequent releases (think about what we do with the bpmn-visualization TypeScript library every 2 weeks at the minimum). In this case, they are only available by installing from GitHub and this is fine.
In this case, the Release Notes should mention that to warn users.

To not forget it, the documentation of the release process should be updated. The release notes should contain a sentence explaining why it is not published on CRAN

@tbouffard tbouffard added the documentation Improvements or additions to documentation label Nov 24, 2022
@tbouffard tbouffard added this to the 0.2.x milestone Nov 24, 2022
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

Successfully merging a pull request may close this issue.

1 participant