Create a Tag in a Github Repository

Better Stack Team
Updated on July 25, 2024

To create a tag in a GitHub repository, you typically need to follow these steps. Tags in Git are used to mark specific points in the repository's history, such as release points or significant commits.

Using Git Command Line

  1. Ensure Local Repository is Up-to-Date: Make sure your local repository is up-to-date with the remote repository:

     
    git fetch origin
    
  2. Checkout the Commit You Want to Tag: Decide which commit or branch you want to tag. Typically, you'll tag a specific commit such as a release commit. Use git log to find the commit hash:

     
    git log --oneline
    

    Once you have the commit hash or the branch name, check it out:

     
    git checkout <commit-hash-or-branch>
    
  3. Create the Tag: Use git tag followed by the tag name to create a lightweight tag. Lightweight tags are simply pointers to specific commits and do not contain additional metadata:

     
    git tag <tag-name>
    

    For example:

     
    git tag v1.0.0
    

    If you want to create an annotated tag with additional information such as tagger's name, email, date, and a message, use the -a option:

     
    git tag -a <tag-name> -m "Tag message"
    

    Replace <tag-name> with your desired tag name and "Tag message" with a descriptive message for the tag.

  4. Push the Tag to GitHub: To push the tag to GitHub, use the git push command with the -tags option:

     
    git push origin <tag-name>
    

    Or, to push all tags at once:

     
    git push origin --tags
    

    This command sends your tags to the remote repository on GitHub.

Using GitHub Web Interface

Alternatively, you can create tags directly on the GitHub web interface:

  1. Navigate to Your Repository: Go to your repository on GitHub.
  2. Click on "Releases" Tab: Click on the "Releases" tab in your repository's navigation bar.
  3. Draft a New Release: Click on "Draft a new release."
  4. Fill in Tag Information:
    • Enter the tag version in the "Tag version" field.
    • Optionally, add a release title and description.
    • Select the target branch or specific commit to associate with this release.
    • Click on "Publish release" when ready.

Conclusion

Creating tags in GitHub repositories allows you to mark specific points in your project's history, making it easier to manage and reference important milestones or releases. Whether using the Git command line or GitHub's web interface, tags are valuable for organizing and documenting your repository's development history.

Got an article suggestion? Let us know
Explore more
Git
Licensed under CC-BY-NC-SA

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Make your mark

Join the writer's program

Are you a developer and love writing and sharing your knowledge with the world? Join our guest writing program and get paid for writing amazing technical guides. We'll get them to the right readers that will appreciate them.

Write for us
Writer of the month
Marin Bezhanov
Marin is a software engineer and architect with a broad range of experience working...
Build on top of Better Stack

Write a script, app or project on top of Better Stack and share it with the world. Make a public repository and share it with us at our email.

community@betterstack.com

or submit a pull request and help us build better products for everyone.

See the full list of amazing projects on github