tiny-update-check 1.1.1

A minimal, lightweight crate update checker for Rust CLI applications
Documentation 
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

name: PR Validation
on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
  cancel-in-progress: true

permissions:
  contents: read
  pull-requests: write

jobs:
  # Semver compatibility check with PR comments
  semver:
    name: Semver Check
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft != true
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # ratchet:actions/checkout@v6.0.2
        with:
          fetch-depth: 0
      - uses: tylerbutler/actions/setup-rust@2189c2e4cd75378b6db8b68ba451bf74d0975c4a # ratchet:tylerbutler/actions/setup-rust@main
      - uses: tylerbutler/actions/install-tools@2189c2e4cd75378b6db8b68ba451bf74d0975c4a # ratchet:tylerbutler/actions/install-tools@main
        with:
          tools: cargo-semver-checks
      - name: Get merge base
        id: merge-base
        run: |
          MERGE_BASE=$(git merge-base origin/main HEAD)
          echo "sha=$MERGE_BASE" >> "$GITHUB_OUTPUT"
      - name: Check semver compatibility
        id: semver
        env:
          MERGE_BASE_SHA: ${{ steps.merge-base.outputs.sha }}
        run: |
          set +e
          OUTPUT=$(cargo +stable semver-checks --baseline-rev "$MERGE_BASE_SHA" --color never 2>&1)
          EXIT_CODE=$?
          echo "$OUTPUT"
          {
            echo "output<<EOF"
            echo "$OUTPUT"
            echo "EOF"
          } >> "$GITHUB_OUTPUT"
          echo "has_breaking=$([[ $EXIT_CODE -ne 0 ]] && echo true || echo false)" >> "$GITHUB_OUTPUT"
          exit 0
      - name: Comment on PR with breaking changes
        if: steps.semver.outputs.has_breaking == 'true'
        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # ratchet:marocchino/sticky-pull-request-comment@v2
        with:
          header: semver-check
          message: |
            ## Semver Breaking Changes Detected

            This PR introduces API changes that may be semver-incompatible:

            ```
            ${{ steps.semver.outputs.output }}
            ```

            If these changes are intentional, please ensure the version bump reflects the breaking change.
      - name: Remove semver comment if no breaking changes
        if: steps.semver.outputs.has_breaking == 'false'
        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # ratchet:marocchino/sticky-pull-request-comment@v2
        with:
          header: semver-check
          delete: true

  # Changelog entry check
  changelog:
    name: Changelog
    runs-on: ubuntu-latest
    if: github.event.pull_request.draft != true
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # ratchet:actions/checkout@v6.0.2
        with:
          fetch-depth: 0
      - uses: tylerbutler/actions/changie-check@a2b6f63843eb7510dbcba273bd6638615f668777 # ratchet:tylerbutler/actions/changie-check@main
        id: changelog
        with:
          base-sha: ${{ github.event.pull_request.base.sha }}
          head-sha: ${{ github.event.pull_request.head.sha }}
      - name: Comment with changelog preview
        if: steps.changelog.outputs.has-entries == 'true'
        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # ratchet:marocchino/sticky-pull-request-comment@v2
        with:
          header: changelog
          message: |
            ## Changelog Preview

            This PR adds the following changelog entries:

            ${{ steps.changelog.outputs.preview }}
      - name: Comment about missing changelog
        if: steps.changelog.outputs.has-entries == 'false' && steps.changelog.outputs.needs-entry == 'true'
        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # ratchet:marocchino/sticky-pull-request-comment@v2
        with:
          header: changelog
          message: |
            ## Missing Changelog Entry

            This PR includes commits with types that typically require a changelog entry (`${{ steps.changelog.outputs.commit-types-found }}`), but no changie fragment was found.

            To add one, run:

            ```
            changie new
            ```
      - name: Remove changelog comment
        if: steps.changelog.outputs.has-entries == 'false' && steps.changelog.outputs.needs-entry == 'false'
        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # ratchet:marocchino/sticky-pull-request-comment@v2
        with:
          header: changelog
          delete: true