Changelog
Source:NEWS.md
fledge 0.1.0 (2021-12-07)
CRAN release: 2021-12-07
Change log management utility, initial release.
The main entry point is bump_version(), which does the following:
- Checks that
DESCRIPTIONandNEWS.mdare clean before bumping, and that the current branch is the main branch. -
update_news(): collectsNEWSentries from top-level commits -
update_version(): bump version inDESCRIPTION, add header toNEWS.md - Depending on the kind of update:
- If “dev”,
finalize_version(): commitDESCRIPTIONandNEWS.md, create tag with message - Otherwise,
commit_version(); the user needs to calltag_version()manually
- If “dev”,
- Suggests to push the changes if an upstream repository is configured.
If you haven’t committed since updating NEWS.md and DESCRIPTION, you can also edit NEWS.md and call tag_version() again. Both the commit and the tag will be updated.
Bumping can be undone with unbump_version().
If the DESCRIPTION has a "Date" field, it is populated with the current date in update_version(). Likewise, if NEWS.md contains dates in the headers, new versions also get a date.
An empty list of changes adds a “Same as previous version” bullet. This allows bumping to a dev version immediately after CRAN release.
Also includes helper functions get_last_tag() and get_top_level_commits().
Includes vignettes: “Get started”, “Using fledge”, and “Fledge internals”. Examples and tests are supported with a demo project, created via with_demo_project().
Thanks Patrick Schratz and Maëlle Salmon for your contributions!