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

feat: add strategy for R packages #2436

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

jolars
Copy link

@jolars jolars commented Nov 19, 2024

Fixes #2151 🦕

I'm new to typescript and javascript, so please take this as a work in progress.

One thing that I couldn't figure out how to handle was how to create a NEWS.md file by default, without explicitly having to specify --changelog-path=NEWS.md. It would be nice if this could be a per-strategy default, but maybe I'm missing something obvious and otherwise I guess that should go into its own issue.

Another issue is that typically R packages have a NEWS.md file with a somewhat different structure, and it doesn't expect a top-level header but instead a package version (typically including name, but I don't think that's necessary). Otherwise some of the tools used in the R community, such as pkgdown have a hard time dealing with the changelogs. A typical NEWS.md file could look like this:

# foofy 1.0.0

## Major changes

* Can now work with all grooveable grobbles!

## Minor improvements and bug fixes

* Printing scrobbles no longer errors (@githubusername, #100).

* Wibbles are now 55% less jibbly (#200).

It was straightforward to remove the Changelog header from the generation. Maybe the header levels should be decremented now, but I'm not sure it matters.

@jolars jolars requested review from a team as code owners November 19, 2024 13:45
@product-auto-label product-auto-label bot added the size: l Pull request size is large. label Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: l Pull request size is large.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add release type for R packages
2 participants