ci(vendor): add a vendor-drift workflow#5
Closed
estebanzimanyi wants to merge 87 commits into
Closed
Conversation
MobilityAPI's working tree is the result of two distinct contribution phases that today's repo doesn't make visible: 1. **pg_mfserv (March 2024)** — the founding OGC API – Moving Features Python server for MobilityDB, authored at ULB. - Maxime Schoemans (@mschoema) — initial commit, endpoint design. - Victor Morabito (@MrMaxime1er) — main developer of the pg_mfserv codebase: column discovery, request handling, exception handling, route refactors. 2. **MobilityAPI (2025–)** — the current production-grade implementation, also at ULB. - Sirine Meraoui (@sirimeraoui) — current maintainer; structured resource layout, tests, OGC conformance, documentation. This commit adds three artefacts that surface the lineage: - **README.md** — new `## History and Acknowledgements` section before `## License` crediting all three contributors and pointing to pg_mfserv as the archived predecessor. - **AUTHORS.md** (new) — structured contributor list per phase. - **CITATION.cff** (new) — machine-readable citation metadata for Zenodo / GitHub citation widget, including a `references:` block citing pg_mfserv as predecessor work. License declared in CITATION.cff: PostgreSQL (matching the MobilityDB main project's license posture). The lineage credit is symmetric: pg_mfserv's README will gain an archive banner pointing forward to MobilityAPI in the companion PR on the pg_mfserv repository. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add lineage credits: pg_mfserv predecessor, AUTHORS, CITATION
…ADME rewrite
The repo is now the canonical home of MobilityAPI but was missing
several artefacts that ecosystem-grade org repos carry:
1. **LICENSE.txt** — The PostgreSQL License, matching the
MobilityDB main project's licence posture. Without this,
the repository was effectively all-rights-reserved by
default. Copyright Université libre de Bruxelles and
MobilityAPI contributors.
2. **CONTRIBUTING.md** — Development setup, test instructions
(./run.sh, ./run.sh --with-tests), code-style conventions
(PEP 8 + ruff), PR conventions. Cross-references AUTHORS.md
and the lineage section in the README.
3. **.github/workflows/python.yml** — Stub CI:
- Lint job: ruff check on PRs (warning-only at this stage so
legacy code isn't blocked; tighten when codebase has been
once-through).
- Import-smoke-test job: imports each application module so
a minimal "code is at least loadable" gate runs on PRs.
No DB-integration tests at this stage; that's a separate
GitHub Actions service-container effort once the test
harness stabilises.
4. **.github/ISSUE_TEMPLATE/{bug,feature}.md** + **PULL_REQUEST_TEMPLATE.md**
— issue / PR scaffolding. Bug template asks for environment
info; feature template prompts for OGC-spec references.
5. **README rewrite** — restructured for canonical-home framing:
- Added badges (License, Python, OGC API conformance).
- Lead with what MobilityAPI is (HTTP / OGC layer of the MEOS
ecosystem) rather than the bare introduction.
- Added a Status section pointing at issues + discussions.
- Added a "Where MobilityAPI fits" section showing peer SQL
layers (MobilityDB / MobilityDuck) and language bindings.
- Cross-link to https://libmeos.org/bindings/mobilityapi/.
- Added Contributing section pointing at CONTRIBUTING.md.
- Fixed "Pyhton" / "Developement" typos and the orphaned
##Poetry section. Final License section points at LICENSE.txt
and CITATION.cff.
- Lineage section (PR #1) preserved unchanged.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Canonicalisation bundle: LICENSE, CI, contributor scaffolding, README rewrite
Vendor MobilityAPI's read-only copy of MEOS-API's published catalog +
projection artefacts under `vendor/meos-api/`, plus a Makefile target
`make vendor-meos-api` that regenerates them from upstream.
Files added:
vendor/meos-api/
PROVENANCE.json -- per-artefact source URLs + regenerate cmd
README.md -- refresh procedure
meos-idl.json -- 3546 fns / 70 structs / 16 enums
(generated by MEOS-API run.py over
MobilityDB master meos/include headers)
meos-coverage.json -- structural worklist (from open PR MobilityDB#4)
meos-object-model-parity.json -- 29-pair portable-parity (from open PR MobilityDB#10)
The Makefile target clones MEOS-API + MobilityDB shallowly, installs
libclang, runs MEOS-API's `run.py` against MobilityDB's MEOS headers,
and copies the produced JSON artefacts into `vendor/meos-api/`.
Two of the four artefacts (`meos-coverage.json`,
`meos-object-model-parity.json`) currently come from open MEOS-API PR
branches because their generators are not yet on master; PROVENANCE.json
makes that explicit. The Makefile gracefully skips them if absent.
Step 2 of `docs/MEOS_API_INGESTION_PLAN.md`. The drift gate workflow
that fails on stale artefacts is step 3 (separate stacked PR).
estebanzimanyi
force-pushed
the
ci/vendor-drift-gate
branch
from
d2d3d58 to
6d58be2
Compare
estebanzimanyi
force-pushed
the
ci/vendor-drift-gate
branch
2 times, most recently
from
efcad95 to
254c8a9
Compare
Adds `.github/workflows/vendor-drift.yml` which regenerates the
vendored MEOS-API artefacts (`make vendor-meos-api`) on every PR
touching `vendor/meos-api/`, the Makefile, or the workflow itself,
plus on push to master and on a daily 06:00 UTC cron. On drift it
fails with an actionable message:
::error::vendor/meos-api/ is stale. Run `make vendor-meos-api`
locally and open a refresh PR.
This is step 3 of `docs/MEOS_API_INGESTION_PLAN.md` ("CI gate that
regenerates the vendored artefacts and fails the PR if they drift").
Stacks on PR MobilityDB#4 (vendoring + Makefile).
estebanzimanyi
force-pushed
the
ci/vendor-drift-gate
branch
from
254c8a9 to
ca4c130
Compare
estebanzimanyi
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Step 3 of
docs/MEOS_API_INGESTION_PLAN.md: a CI gate that regeneratesvendor/meos-api/from MEOS-API + MobilityDB master and fails the PR if any committed artefact is stale.Trigger
vendor/meos-api/**,Makefile, or the workflow itselfmaster(post-merge sanity)workflow_dispatchBehaviour
The workflow installs
clang libclang-dev libjson-c-dev libgsl-dev libproj-dev libgeos-dev postgresql-server-dev-allso libclang's sysroot resolves the same way as a local checkout, runsmake vendor-meos-api, andgit diff --exit-code -- vendor/meos-api/. On drift it emits:Stacks on #4 (the
make vendor-meos-apiMakefile target + the vendored artefacts).