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

Add gh release update #2873

Closed
kzu opened this issue Jan 29, 2021 · 1 comment
Closed

Add gh release update #2873

kzu opened this issue Jan 29, 2021 · 1 comment
Labels
enhancement a request to improve CLI

Comments

@kzu
Copy link

kzu commented Jan 29, 2021

Describe the feature or problem you’d like to solve

Currently you can gh release create and gh release upload, but editing of the release notes themselves is not possible.

This would be very useful to automate changelog generation, for example, so that:

  1. Human creates a release on GitHub Releases page, gives it the desired tag name
  2. Workflow runs, generates a changelog, and updates the release notes with that using the GH CLI

Proposed solution

I see two choices here:

  1. Introduce a new update command, likely with most (all?) arguments from create
  2. Extend the upload and add -n, --notes and -F, --notes-file args and make files optional (not sure if it is already), so that upload can simply update the notes while (optionally) uploading files.

Additional context

I'm aware that this is almost trivially achieved with plain REST calls or pre-built GH actions in the marketplace. But I'm leaning towards simplifying workflows by having very explicit GH CLI calls instead, so it's very clear what's being done at each workflow step, and customizability is boundless.

@kzu kzu added the enhancement a request to improve CLI label Jan 29, 2021
@mislav
Copy link
Contributor

mislav commented Feb 1, 2021

Thank you for the feature request! Editing different aspects of a release comes up as a feature request from time, so I'm going to merge all existing issues as duplicate of #1997

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

No branches or pull requests

2 participants