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

Allow release_bullets() to go in any section #1818

Open
Bisaloo opened this issue Apr 6, 2023 · 2 comments
Open

Allow release_bullets() to go in any section #1818

Bisaloo opened this issue Apr 6, 2023 · 2 comments
Labels
feature a feature request or enhancement release 🛫

Comments

@Bisaloo
Copy link
Contributor

Bisaloo commented Apr 6, 2023

It is currently possible to add custom bullets to the checklist generated by usethis::use_release_issue() through the creation of an unexported release_bullets() function.

But the release issue checklist contains several sections:

  • First release (in some cases)
  • Prepare for release
  • Submit to CRAN
  • Wait for CRAN...

and it's only possible to add new items to "Prepare for release".

But one may want to add custom item in other sections. In particular, in the last section, post-CRAN acceptance. One example could be "share it on slack". Or before the first release: "verify that the package is set up for upload on zenodo".

I'm not completely sure what the best way to implement this would be. My initial idea would be for release_bullets() to return a named list of vectors instead of a single vector but it would be a breaking change.

@jennybc
Copy link
Member

jennybc commented Apr 21, 2023

I'm not completely sure what the best way to implement this would be

Yeah that is the dilemma. I'm not exactly keen to enter into a formal "contract" about the sections, which would be necessary to allow custom bullets to be inserted into specific sections.

Maybe the right thing to do is to place custom bullets in their own section, knowing that a maintainer can edit the checklist and move them, if they wish. I know that's not ideal, but it might be the right compromise.

It's also possible that the status quo is equivalent and we should do nothing.

@hadley
Copy link
Member

hadley commented Nov 3, 2023

Maybe we could base them on the heading name, and any bullets that don't match a heading just go at the end. (So we're still covered if we change the header name.)

@hadley hadley added the feature a feature request or enhancement label Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement release 🛫
Projects
None yet
Development

No branches or pull requests

3 participants