In cynkra/fledge: Smoother Change Tracking and Versioning for R Packages
Do you want to provide a changelog (NEWS.md) more informative than "bug fixes and performance improvements" (https://twitter.com/EmilyKager/status/1413628436984188933) to the users of your package?
Ways to achieve that are:
-
Update NEWS.md right before release by reading through commit messages. Not necessarily fun!
-
Update the changelog in every commit e.g. in every PR. Now, if there are several feature PRs around that update the changelog, you'll have a few clicks to make to tackle conflicts. Easy enough, but potentially annoying.
-
Use fledge to
- fill the
NEWS.md for you based on informative commit messages,
- (optionally) increase the version number in
DESCRIPTION (e.g. useful in bug reports with session information!),
- (optionally) create git tags (more coarse-grained history compared to top-level merges see fledge tag list on GitHub).
Using fledge is a discipline, a few habits, that are worth learning!
cynkra/fledge documentation built on April 17, 2025, 3:56 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Do you want to provide a changelog (NEWS.md) more informative than "bug fixes and performance improvements" (https://twitter.com/EmilyKager/status/1413628436984188933) to the users of your package?
Ways to achieve that are:
-
Update NEWS.md right before release by reading through commit messages. Not necessarily fun!
-
Update the changelog in every commit e.g. in every PR. Now, if there are several feature PRs around that update the changelog, you'll have a few clicks to make to tackle conflicts. Easy enough, but potentially annoying.
-
Use fledge to
- fill the
NEWS.mdfor you based on informative commit messages, - (optionally) increase the version number in
DESCRIPTION(e.g. useful in bug reports with session information!), - (optionally) create git tags (more coarse-grained history compared to top-level merges see fledge tag list on GitHub).
- fill the
Using fledge is a discipline, a few habits, that are worth learning!
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.