Learn how to mark releases with Git tags in GitHub Actions

Learn how to mark releases with Git tags in GitHub Actions

Git tags are a powerful way to mark specific points in the repository history, such as stable releases or milestones. Using Git tags in GitHub Actions allows you to create, update, and manage tags as part of your CI/CD workflows.

Here are the steps to follow while creating Git Tags in GitHub Actions.

1. Creating a Git Tag

You can create a Git tag in your GitHub Actions workflow using the git command to tag a specific commit or branch.

Example Workflow for Creating a Git Tag

xxxxxxxxxx
17
1
name: Create Git Tag
2
on:
3
  push:
4
    branches:
5
     - main
6
jobs:
7
  create-tag:
8
    runs-on: ubuntu-latest
9
    steps:
10
     - name: Checkout Repository
11
        uses: actions/checkout@v3
12
     - name: Create Git Tag
13
        run: |
14
          git config --local user.name "Your Name"
15
          git config --local user.email "you@example.com"
16
          git tag -a v1.0.0 -m "Release version 1.0.0"
17
          git push origin v1.0.0

In this example:

A tag v1.0.0 is created and pushed to the remote repository after a successful commit or push to the main branch.

2. Updating an Existing Tag

You can update or modify existing tags by using the git tag -f command or by rewriting history, followed by pushing the updated tags.

Example Workflow for Updating a Tag

xxxxxxxxxx
17
1
name: Update Git Tag
2
on:
3
  push:
4
    branches:
5
     - main
6
jobs:
7
  update-tag:
8
    runs-on: ubuntu-latest
9
    steps:
10
     - name: Checkout Repository
11
        uses: actions/checkout@v3
12
     - name: Update Git Tag
13
        run: |
14
          git config --local user.name "Your Name"
15
          git config --local user.email "you@example.com"
16
          git tag -f v1.0.0 -m "Updated release version 1.0.0"
17
          git push origin v1.0.0

In this workflow:

The existing tag v1.0.0 is force-updated with a new commit message.

3. Using Git Tags with Releases

Git tags can also be associated with GitHub Releases, making it easier to manage release artifacts alongside version control.

Example Workflow with Git Tag and Release

xxxxxxxxxx
23
1
name: Release with Git Tag
2
on:
3
  push:
4
    branches:
5
     - main
6
jobs:
7
  release:
8
    runs-on: ubuntu-latest
9
    steps:
10
     - name: Checkout Repository
11
        uses: actions/checkout@v3
12
     - name: Create Git Tag
13
        run: |
14
          git config --local user.name "Your Name"
15
          git config --local user.email "you@example.com"
16
          git tag v1.0.0 -m "Release version 1.0.0"
17
          git push origin v1.0.0
18
     - name: Create GitHub Release
19
        uses: actions/create-release@v2
20
        with:
21
          tag_name: v1.0.0
22
          release_name: "Release v1.0.0"
23
          body: "This is the first release."

In this workflow:

A Git tag is created, and then a GitHub Release is associated with that tag.

4. Using Git Tags with Workflow Versioning

Tags can be used for version control within your workflows to identify specific builds and deployments.

Example: Using Tags in Workflows

xxxxxxxxxx
13
1
name: Deploy with Versioned Tag
2
on:
3
  push:
4
    tags:
5
     - v1.
6
jobs:
7
  deploy:
8
    runs-on: ubuntu-latest
9
    steps:
10
     - name: Checkout Repository
11
        uses: actions/checkout@v3
12
     - name: Deploy to Production
13
        run: ./deploy.sh

Here, the workflow only triggers deployments when the tag matches a specific pattern, e.g., v1..

5. Deleting Git Tags

You can delete Git tags via Git commands in workflows if necessary.

Example: Deleting a Git Tag

xxxxxxxxxx
15
1
name: Delete Git Tag
2
on:
3
  workflow_run:
4
    workflows:
5
     - Create Git Tag
6
jobs:
7
  delete-tag:
8
    runs-on: ubuntu-latest
9
    steps:
10
     - name: Checkout Repository
11
        uses: actions/checkout@v3
12
     - name: Delete Git Tag
13
        run: |
14
          git tag -d v1.0.0
15
          git push origin --delete v1.0.0

Best Practices for Using Git Tags in Actions

1. Consistent Naming: Use meaningful tag names (e.g., v1.0.0, release-2024.12).

2. Automation: Use Git tags as a versioning mechanism for continuous integration pipelines.

3. Push & Sync: Ensure tags are consistently pushed to both local and remote repositories.

4. Documentation: Document tagged releases for better traceability.