Skip to content

Improve documentation to distinguish between gh release create --notes-from-tag and --generate-notes #8372

@williammartin

Description

@williammartin

Description

We received some feedback that it wasn't obvious what the difference between --notes-from-tag and --generate-notes flags were on gh release create. Specifically, it's a bit confusing because --generate-notes actually calls the generate-notes endpoint where as --notes-from-tag mostly just formats the contents of an annotated tag with git tag --list <TAG> --format=%(contents:subject)%0a%0a%(contents:body) so the word "generation" is doing some heavy lifting and is perhaps a bit confusing.

I suggest we just update the command help and avoid using the word generation for --notes-from-tag.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsenhancementa request to improve CLIgh-releaserelating to the gh release commandhelp wantedContributions welcome

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions