Guide through the package/project release process.
Guides through the complete package release process for R, npm, or GitHub projects
/plugin marketplace add Data-Wise/craft/plugin install data-wise-craft@Data-Wise/craftcode/Guide through the package/project release process.
Manage releases for:
Version bump
Quality checks
Documentation
Final verification
Commit changes
Tag release
git tag vX.Y.ZPush
git push && git push --tagsCreate GitHub release
Submit to repository (if applicable)
## Release Checklist: v[X.Y.Z]
### Pre-Release
- [ ] Version bumped in [files]
- [ ] NEWS.md/CHANGELOG updated
- [ ] Tests passing
- [ ] R CMD check: 0 errors, 0 warnings, 0 notes
- [ ] Documentation updated
- [ ] Examples verified
### Release
- [ ] Changes committed
- [ ] Tag created: vX.Y.Z
- [ ] Pushed to remote
- [ ] GitHub release created
- [ ] [CRAN/npm] submission completed
### Post-Release
- [ ] Bump to development version (X.Y.Z.9000)
- [ ] Announce release (if applicable)
# Version bump
usethis::use_version("minor")
# Update NEWS
usethis::use_news_md()
# Final checks
devtools::check()
devtools::check_win_devel()
devtools::check_rhub()
# Submit to CRAN
devtools::release()
# Version bump
npm version minor
# Publish
npm publish
Uses these tools when available:
r_check - Run R CMD checkr_test - Run test suiter_coverage - Check coverageRequest: "Help me release v1.2.0 of my R package"
Request: "Create a patch release for a bug fix"
Request: "Guide me through CRAN submission checklist"
Request: "Prepare release notes from recent commits"
/releasePrepare a new release by updating changelog, version, and documentation