Skip to content

Follow guidance for git tagging in contribution docs#1386

Merged
elenatanasoiu merged 1 commit intomainfrom
elenatanasoiu/update-release-docs
Jun 15, 2022
Merged

Follow guidance for git tagging in contribution docs#1386
elenatanasoiu merged 1 commit intomainfrom
elenatanasoiu/update-release-docs

Conversation

@elenatanasoiu
Copy link
Copy Markdown
Contributor

@elenatanasoiu elenatanasoiu commented Jun 15, 2022

Adding two things:

  • A bit more detail on how to add a tag and how to delete a badly named one
  • Switch to the official way of sharing tags according to the git docs 1

Checklist

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

Footnotes

  1. https://git-scm.com/book/en/v2/Git-Basics-Tagging

@elenatanasoiu elenatanasoiu requested a review from a team as a code owner June 15, 2022 14:51
@elenatanasoiu elenatanasoiu requested a review from a team June 15, 2022 14:52
Copy link
Copy Markdown
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this and being explicit about how tagging works 🤗 🏷️

Just a minor comment from me 💭

Comment thread CONTRIBUTING.md Outdated
@sampart
Copy link
Copy Markdown
Contributor

sampart commented Jun 15, 2022

Folk can also do this via https://github.com/github/vscode-codeql/releases/new. I've not tested on this repo, but on others I've found that creating a tag this way still triggers the necessary build steps. It may not be worth including, but I thought I'd mention it.

@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/update-release-docs branch from 381f645 to 35204bd Compare June 15, 2022 15:54
Adding two things:
- A bit more detail on how to add a tag and how to delete a badly named one
- Switch to the official way of sharing tags according to the git docs[^1]

[^1]: https://git-scm.com/book/en/v2/Git-Basics-Tagging
@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/update-release-docs branch from 35204bd to 0b15a16 Compare June 15, 2022 15:57
@elenatanasoiu
Copy link
Copy Markdown
Contributor Author

Thanks @sampart! It's not 100% clear to me if you can create a "draft" release via that link so I've chosen to stick with the flow we already have.

Copy link
Copy Markdown
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM 🚀

@elenatanasoiu elenatanasoiu merged commit ecea7f4 into main Jun 15, 2022
@elenatanasoiu elenatanasoiu deleted the elenatanasoiu/update-release-docs branch June 15, 2022 16:27
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

Successfully merging this pull request may close these issues.

3 participants