MobilityAPI-Python/.github/workflows/vendor-drift.yml at master · MobilityDB/MobilityAPI-Python · GitHub

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
118
119
120
121
122
123
124
125
126
127
128
129
130
name: Vendor drift (MEOS-API)

# Re-runs the `make vendor-meos-api` target against the live MEOS-API master
# and reports when the vendored artefacts under `vendor/meos-api/` are out of
# date.
#
# Surfaces upstream changes as actionable PR diffs instead of letting them
# silently rot. On a pull request touching the vendored copy the drift fails
# the run, and the message tells the author to run
#
#   make vendor-meos-api
#
# locally and include the result. Every other run opens that refresh pull
# request itself, since MEOS-API master moves most days and there is no author
# to address.
#
# Step 3 of `docs/MEOS_API_INGESTION_PLAN.md`.

on:
  pull_request:
    paths:
      - 'vendor/meos-api/**'
      - 'Makefile'
      - '.github/workflows/vendor-drift.yml'
  push:
    branches: [master]
  schedule:
    # Daily 06:00 UTC — pings the maintainer if MEOS-API master moves and the
    # vendored copy goes stale, even without a MobilityAPI PR open.
    - cron: '0 6 * * *'
  workflow_dispatch:

# The scheduled run commits the refreshed artefacts to a branch and opens a
# pull request for them.
permissions:
  contents: write
  pull-requests: write

jobs:
  vendor-drift:
    name: Refresh & diff vendored artefacts
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          # `git diff` against the base needs the history the two share.
          fetch-depth: 0

      # A pull request that changes the vendored copy, or the target that
      # writes it, owns keeping it current. One that changes only this
      # workflow does not, and failing it for a staleness it did not cause
      # would block the very change that stops the staleness failing.
      - name: Note whether this pull request owns the vendored copy
        id: owns
        if: github.event_name == 'pull_request'
        run: |
          git fetch --no-tags origin "${{ github.base_ref }}"
          if git diff --name-only FETCH_HEAD...HEAD -- vendor/meos-api Makefile | grep -q .; then
            echo "owns=true" >> "$GITHUB_OUTPUT"
          else
            echo "owns=false" >> "$GITHUB_OUTPUT"
            echo "::notice::This pull request changes neither vendor/meos-api nor the Makefile, so a drift is reported rather than failed."
          fi

      # libclang (the Python wheel) bundles the .so but not the system C
      # headers MEOS depends on (json-c, gsl, proj, postgres). Without them,
      # `size_t` degrades to `int`, `json_object *` degrades to `int *`, etc.,
      # which would show up as false drift on every CI run. Install the same
      # dev headers a local MobilityDB build expects so libclang resolves
      # everything correctly.
      - name: Install dev headers for libclang sysroot (matches local parse)
        run: |
          sudo apt-get update -qq
          sudo apt-get install -y --no-install-recommends \
            clang libclang-dev \
            libjson-c-dev libgsl-dev libproj-dev libgeos-dev \
            postgresql-server-dev-16

      - name: Refresh vendored MEOS-API artefacts from master
        run: make vendor-meos-api

      # A pull request that changes the vendored copy or the target that writes
      # it must not leave it stale, and its author is there to act, so there the
      # drift is an error.
      #
      # Nobody is there to act on a schedule or on a push already made, and
      # MEOS-API master moves most days, so failing whenever it had moved would
      # fail most days and report a difference no one could address from a run
      # log. Those runs open the refresh instead, and the pull request they
      # open carries the diff.
      - name: Detect drift
        id: drift
        run: |
          if git diff --exit-code -- vendor/meos-api/; then
            echo "drift=false" >> "$GITHUB_OUTPUT"
            echo "::notice::vendor/meos-api/ is up to date with MEOS-API master."
          else
            echo "drift=true" >> "$GITHUB_OUTPUT"
            git diff --stat -- vendor/meos-api/
            if [ "${{ steps.owns.outputs.owns }}" = "true" ]; then
              echo "::error::vendor/meos-api/ is stale. Run \`make vendor-meos-api\` locally and include the result."
              exit 1
            fi
            if [ "${{ github.event_name }}" = "pull_request" ]; then
              echo "::notice::vendor/meos-api/ is stale, which this pull request does not cause and does not have to fix."
            else
              echo "::notice::vendor/meos-api/ is stale; opening a refresh pull request."
            fi
          fi

      # `add-paths` stages only what it lists, so it names every path
      # `make vendor-meos-api` writes; anything omitted would be regenerated
      # and then silently discarded. The action reuses its branch, so a later
      # run updates this pull request rather than opening another one.
      - name: Open a refresh pull request
        if: github.event_name != 'pull_request' && steps.drift.outputs.drift == 'true'
        uses: peter-evans/create-pull-request@v6
        with:
          add-paths: vendor/meos-api
          branch: tooling/refresh-meos-api-vendor
          delete-branch: true
          commit-message: "Refresh the vendored MEOS-API artefacts"
          title: "Refresh the vendored MEOS-API artefacts"
          body: |
            `make vendor-meos-api` regenerates `vendor/meos-api/` from MEOS-API
            master and the MobilityDB headers it parses, and the result differs
            from the committed copy.

            Opened by the scheduled `Vendor drift (MEOS-API)` run, which reruns
            daily and updates this pull request while the difference stands.