Use tags to mark specific Git commits

Assign a tag to a commit

1. Open the Git tool window Alt+9 and switch to the Log tab.

2. Locate the commit you want, right-click it and select New Tag from the context menu.

3. Enter the name of the new tag and click OK. The tag will be shown in the Log tab of the Git tool window Alt+9:

   

Assign an annotated tag to a commit

Meta-data for annotated tags contains the name of the user who created them, so they allow you to check who placed them.

1. In the main menu, go to Git | New Tag.

2. In the Tag dialog that opens, under Git Root, select the path to the local repository in which you want to tag a commit, and specify the name of the new tag.

3. In the Commit field, specify the commit that you want to tag. You can enter the commit hash, or use an expression, for example: <branch>~<number of commits backwards between the latest commit (HEAD) and the required commit>. For more information, refer to Git commit naming conventions.

4. Enter some comment in the Message field to create an annotated tag (if it's empty, a regular tag will be created).

5. Click Create Tag.

Reassign an existing tag

If you've placed a tag on a wrong commit, and want to reassign it (for example, to indicate a commit for a release version), do the following:

1. In the main menu, go to Git | New Tag.

2. In the Tag dialog, in the Tag Name field specify the name of an already existing tag that you want to reassign.

3. Select the Force option.

4. In the Commit field, specify the commit where to move the tag and click Create Tag.

Jump to a tagged commit

1. Open the Git tool window Alt+9 and switch to the Log tab.

2. Click the Go To Hash/Branch/Tag icon on the toolbar, or press Ctrl+F.

   

3. Enter the tag name (code completion suggests tag names as you type) and press Enter.

Check out a tagged commit

Suppose you marked a commit that corresponds to a release version with a tag, and now you want to review the snapshot of your project at that point in time. You can do this by checking out a tagged commit. Do one of the following:

• Locate the tagged commit that you want to checkout, right-click it and select Checkout Revision from the context menu.

• Invoke the branches popup, click Checkout Tag or Revision and type in the tag name (PyCharm provides a list of matching tags and revisions as you type).

Note that this operation results in a detached HEAD, which means you are no longer in any branch. You can use this snapshot for inspection and experiments. However, if you want to commit changes on top of this snapshot, you will need to create a branch.

Push a tag

By default, when you perform the push operation, tags are not sent to the remote repositories. To push tags:

1. In the Push Commits dialogue, select the Push tags checkbox in the bottom-left corner.

   

2. In the drop-down menu, select the tags you want to push:

   • Select All if you want to push all tags, including the tags that do not belong to the selected branches you are about to push (equivalent to push --tags).

   • Select Current Branch if you want to push only the tags that belong to the selected branches you are about to push (equivalent to push --follow-tags).

3. Click Push.

Delete a tag

• Locate a tagged commit, right-click it and select Tag <tag_name> | Delete from the context menu.