Skip to content

Releases: cynkra/fledge

fledge 0.1.1

21 Jun 09:55
Compare
Choose a tag to compare
  • Compatibility release for usethis 2.2.0.

fledge 0.1.0

07 Dec 21:10
Compare
Choose a tag to compare

Change log management utility, initial release.

The main entry point is bump_version(), which does the following:

  1. Checks that DESCRIPTION and NEWS.md are clean before bumping, and that the current branch is the main branch.
  2. update_news(): collects NEWS entries from top-level commits
  3. update_version(): bump version in DESCRIPTION, add header to NEWS.md
  4. Depending on the kind of update:
    • If "dev", finalize_version(): commit DESCRIPTION and NEWS.md, create tag with message
    • Otherwise, commit_version(); the user needs to call tag_version() manually
  5. 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!

fledge 0.0.4

08 Mar 06:07
Compare
Choose a tag to compare

Features

  • Prepend NEWS comment to discourage edits.
  • Dates are added to NEWS headers if existing headers have them, or for a new NEWS file (#29).
  • finalize_version() gains push argument which pushes the tag and the main branch, this considerably simplifies the workflow. It calls edit_news() and sends finalize_version(push = TRUE) to the RStudio or VS Code console.
  • tag_version() returns name of created tag, invisibly.
  • tag_version(force = FALSE) re-tags an existing tag if it points to the same commit.

Bug fixes

  • bump_version() gives correct advice if no remote branch exists.
  • bump_version() and get_top_level_commits() are more robust at enumerating the commits: traversing the first parent from which since can be reached, instead of the first parent. This ensures that NEWS are more meaningful and avoids the occasional enumeration of all NEWS items since the beginning.

Internal

  • Add Patrick Schratz (@pat-s) a contributor (#50).
  • Use GitHub Actions (#49).
  • Move from ui_* to {cli} (#54)
  • Import rlang.