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

use {fledge} for release management #981

Closed
lorenzwalthert opened this issue Aug 21, 2022 · 7 comments
Closed

use {fledge} for release management #981

lorenzwalthert opened this issue Aug 21, 2022 · 7 comments

Comments

@lorenzwalthert
Copy link
Collaborator

Re: #977 (comment)

The problem I have with that approach is that I don't see from the documentation how you can make different sections in NEWS.md, which is recommended by the tidyverse style guide. Can you confirm that this is not possible or how to work around it @krlmlr?

@krlmlr
Copy link
Member

krlmlr commented Aug 21, 2022

We now support a subset of conventional commits, these are translated into sections.

@lorenzwalthert
Copy link
Collaborator Author

lorenzwalthert commented Aug 21, 2022

Ok, I could not find the relevant section in the docs... After looking at the docs for > 15 mins, I still don't feel like I know how it works (maybe just me, it's late?). I think the get started vignette and the README repeats itself a few times is not 100% clear with terminology, so I got a bit confused. Because after all it is not that complicated when I tried it out hands-on.

In particular, this section in the docs was confusing for me:

Screenshot 2022-08-21 at 21 25 00

-> 'News is now composed' (wait, by finalize_version()) or by me previously?

Screenshot 2022-08-21 at 21 45 52

-> 'If you add to edit'? I don't understand that sentence.

@krlmlr
Copy link
Member

krlmlr commented Aug 22, 2022

Thanks for your feedback. Would a video have helped?

To clarify:

  • fledge expands NEWS.md, that's its purpose
  • "add to edit" is a typo, should be "after you add to NEWS.md" or "after you edit NEWS.md" or similar

@lorenzwalthert
Copy link
Collaborator Author

lorenzwalthert commented Aug 22, 2022

Thanks.

fledge expands NEWS.md, that's its purpose

That was clear from the beginning for me, but not how it would do that, when/if it would overwrite my manual edits etc, that I can't have an up to date NEWS.md unless you make a new release with bump_version() (because in this repo, NEWS.md is always up to date).

Yes, a video would definitively have helped, if I understand correctly, all I need to know to make it work is to know when I have to call bump_version(), when I can edit the changelog without getting overwritten and when to call finalize(). Thanks Kirill for your patience.

@lorenzwalthert
Copy link
Collaborator Author

lorenzwalthert commented Sep 11, 2022

Ok, I now used {fledge} for tag 1.7.002 🎉. Next step would be to update CONTRIBUTING.md to reflect these change, i.e.

  • Don't add news bullet to PR,
  • handle PR commit messages right so {fledge} can understand them or use the PR title.
  • regularly run bump_version() and finalize_version(push = TRUE).

@lorenzwalthert
Copy link
Collaborator Author

Also, @IndrajeetPatil in order to use PR tiles for {fledge}, I think we need to create explicit merge commits with PRs, as the home page says at https://cynkra.github.io/fledge/dev/.

@lorenzwalthert
Copy link
Collaborator Author

lorenzwalthert commented Feb 14, 2024

Sorry this has not worked for me. I can’t recall the exact problems but I got error messages sometimes and when merging, I don’t consistently set the title of the merge commit to make it into tie change log. Also, I find it much easier to just compile the channeling by reviewing all PR titles. If anyone else takes over maintenance of styler at some point, feel free to reopen. Also, I find it not 100% transparent what some of the commands do and docs sometimes did not help me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants