Commit a file if it changed#

This recipe runs a Python script to update a README, then commits it back to the parent repo but only if it has changed:

1
on:
2
  push:
3
    branches:
4
    - master
5
# ...
6
    - name: Update README
7
      run: python update_readme.py --rewrite
8
    - name: Commit README back to the repo
9
      run: |-
10
        git config --global user.email "readme-bot@example.com"
11
        git config --global user.name "README-bot"
12
        git diff --quiet || (git add README.md && git commit -m "Updated README")
13
        git push

My first attempt threw an error if I tried o run git commit -m ... and the README had not changed.

It turns out git diff --quiet exits with a 1 exit code if anything has changed, so this recipe adds the file and commits it only if something differs:

1
git diff --quiet || (git add README.md && git commit -m "Updated README")

Mikeal Rogers has a publish-to-github-action which uses a slightly different pattern:

1
# publish any new files
2
git checkout master
3
git add -A
4
timestamp=$(date -u)
5
git commit -m "Automated publish: ${timestamp} ${GITHUB_SHA}" || exit 0
6
git pull --rebase publisher master
7
git push publisher master

Cleanest example yet: https://github.com/simonw/coronavirus-data-gov-archive/blob/master/.github/workflows/scheduled.yml

1
name: Fetch latest data
2

3
on:
4
  push:
5
  repository_dispatch:
6
  schedule:
7
    - cron:  '25 * * * *'
8

9
jobs:
10
  scheduled:
11
    runs-on: ubuntu-latest
12
    steps:
13
    - name: Check out this repo
14
      uses: actions/checkout@v2
15
    - name: Fetch latest data
16
      run: |-
17
        curl https://c19downloads.azureedge.net/downloads/data/data_latest.json | jq . > data_latest.json
18
        curl https://c19pub.azureedge.net/utlas.geojson | gunzip | jq . > utlas.geojson
19
        curl https://c19pub.azureedge.net/countries.geojson | gunzip | jq . > countries.geojson
20
        curl https://c19pub.azureedge.net/regions.geojson | gunzip | jq . > regions.geojson
21
    - name: Commit and push if it changed
22
      run: |-
23
        git config user.name "Automated"
24
        git config user.email "actions@users.noreply.github.com"
25
        git add -A
26
        timestamp=$(date -u)
27
        git commit -m "Latest data: ${timestamp}" || exit 0
28
        git push

Newsletter

Commit a file if it changed#