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 annotated tags for releases #30

Merged
merged 1 commit into from
Mar 9, 2021
Merged

Use annotated tags for releases #30

merged 1 commit into from
Mar 9, 2021

Conversation

SeanTAllen
Copy link
Member

The X.Y.Z tag will live on. Use an annotated tag as they can be signed.

From the documentation:

Annotated tags, however, are stored as full objects in the Git database.
They’re checksummed; contain the tagger name, email, and date; have a
tagging message; and can be signed and verified with GNU Privacy Guard
(GPG). It’s generally recommended that you create annotated tags so you
can have all this information; but if you want a temporary tag or for
some reason don’t want to keep the other information, lightweight tags
are available too.

@SeanTAllen SeanTAllen added the changelog - changed Automatically add "Changed" CHANGELOG entry on merge label Mar 9, 2021
@ponylang-main
Copy link
Contributor

Hi @SeanTAllen,

The changelog - changed label was added to this pull request; all PRs with a changelog label need to have release notes included as part of the PR. If you haven't added release notes already, please do.

Release notes are added by creating a uniquely named file in the .release-notes directory. We suggest you call the file 30.md to match the number of this pull request.

The basic format of the release notes (using markdown) should be:

## Title

End user description of changes, why it's important,
problems it solves etc.

If a breaking change, make sure to include 1 or more
examples what code would look like prior to this change
and how to update it to work after this change.

Thanks.

The X.Y.Z tag will live on. Use an annotated tag as they can be signed.

From the documentation:

Annotated tags, however, are stored as full objects in the Git database.
They’re checksummed; contain the tagger name, email, and date; have a
tagging message; and can be signed and verified with GNU Privacy Guard
(GPG). It’s generally recommended that you create annotated tags so you
can have all this information; but if you want a temporary tag or for
some reason don’t want to keep the other information, lightweight tags
are available too.
@SeanTAllen SeanTAllen merged commit 0bf06b5 into main Mar 9, 2021
@SeanTAllen SeanTAllen deleted the use-annotated-tag branch March 9, 2021 19:58
github-actions bot pushed a commit that referenced this pull request Mar 9, 2021
github-actions bot pushed a commit that referenced this pull request Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog - changed Automatically add "Changed" CHANGELOG entry on merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants