gitcraft 0.1.123

A template project for GitHub-related utilities.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# .github/workflows/release-automation.yml
name: Release Automation

on:
  workflow_dispatch: # Allows manual triggering of the workflow
  push:
    branches:
      - main
    tags:
      - 'v*'  # Triggers on any tag starting with 'v'

permissions:
  contents: write  # Required for pushing changes

jobs:
  update-docs:
    runs-on: ubuntu-latest
    
    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
      with:
        ref: main  # Checkout main branch instead of the tag
        fetch-depth: 0  # Fetch all history for all tags and branches
        token: ${{ secrets.GITHUB_TOKEN }}
    
    - name: Get the version from tag
      id: get_version
      if: github.ref_type == 'tag'
      run: echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
    
    - name: Update README.md
      if: github.ref_type == 'tag'
      run: |
        VERSION=${{ steps.get_version.outputs.VERSION }}

        # Update all GitHub release **tag** links
        sed -E -i "s|https://github.com/RafaelJohn9/gh-templates/releases/tag/v[0-9]+\.[0-9]+\.[0-9]+|https://github.com/RafaelJohn9/gh-templates/releases/tag/$VERSION|g" README.md

        # Update all GitHub release **download** links
        sed -E -i "s|https://github.com/RafaelJohn9/gh-templates/releases/download/v[0-9]+\.[0-9]+\.[0-9]+|https://github.com/RafaelJohn9/gh-templates/releases/download/$VERSION|g" README.md

    - name: Install git-cliff
      uses: taiki-e/install-action@v2
      with:
        tool: git-cliff

    - name: Update CHANGELOG
      run: |
        if [[ $GITHUB_REF == refs/tags/* ]]; then
          # On tag: Generate full history
          git-cliff --output CHANGELOG.md
        else
          # On push to main: Only unreleased changes
          git-cliff --unreleased --prepend CHANGELOG.md
        fi

    - name: Check if files were modified
      id: check_changes
      run: |
        if git diff --quiet README.md CHANGELOG.md; then
          echo "changed=false" >> $GITHUB_OUTPUT
        else
          echo "changed=true" >> $GITHUB_OUTPUT
        fi
    
    - name: Commit and push changes
      if: steps.check_changes.outputs.changed == 'true'
      run: |
        git config --local user.email "github-actions[bot]@users.noreply.github.com"
        git config --local user.name "github-actions[bot]"
        
        # Add any modified files
        git add README.md CHANGELOG.md
        
        # Create appropriate commit message based on trigger
        if [[ $GITHUB_REF == refs/tags/* ]]; then
          git commit -m "chore: update documentation for ${{ steps.get_version.outputs.VERSION }} [skip ci]"
        else
          git commit -m "chore: update CHANGELOG [skip ci]"
        fi
        
        # Pull and push changes
        git pull --rebase origin main
        git push origin main
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}