matrix-org / matrix-org/complement
Build tag configuration duplicated in many places
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 99
- Forks
- 72
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 8
Description
Currently the build tags get duplicated in a handful of places:
* Complement [CI in GHA](https://github.com/matrix-org/complement/blob/186321ff9299a33d9c9ddd468b1529e7224d38ed/.github/workflows/ci.yaml#L25-L32)
* ~~Complement [CI](https://github.com/matrix-org/pipelines/blob/22c9dbecababac41f1383bb41125de961bd31d14/complement/pipeline.yml#L35) in [Buildkite](https://github.com/matrix-org/pipelines/blob/22c9dbecababac41f1383bb41125de961bd31d14/complement/pipeline.yml#L62)~~
* Synapse [CI in GHA](https://github.com/matrix-org/synapse/blob/11540be55ed15da920fa6f3ea805315517c02c76/.github/workflows/tests.yml#L347)
* Synapse [`complement.sh` script](https://github.com/matrix-org/synapse/blob/11540be55ed15da920fa6f3ea805315517c02c76/scripts-dev/complement.sh#L68)
* ~~Synapse [CI in Buildkite](https://github.com/matrix-org/pipelines/blob/22c9dbecababac41f1383bb41125de961bd31d14/synapse/pipeline.yml#L570) (which is actually unused, but still sometimes kept in sync)~~
* Dendrite [CI in Buildkite](https://github.com/matrix-org/pipelines/blob/22c9dbecababac41f1383bb41125de961bd31d14/dendrite/pipeline.yml#L59)
Note that the build tags are homeserver specific (and might vary based on the version of the homeserver).
It would be great if complement was able to know which build tags to use somehow by inspecting a file or the homeserver capabilities. This would help avoid the various configs above getting out of sync.
Additionally we should probably:
* Remove the buildkite CI for complement.
* Remove the unused pipeline for Synapse.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the build-tag definitions in .github/workflows/ci.yaml, .github/workflows/tests.yml, scripts-dev/complement.sh, and the referenced Complement, Synapse, and Dendrite pipeline files. Start by mapping which tags each homeserver version needs and where they are consumed. Done means the configurations stay in sync through a single discoverable source or capability check, with the unused Buildkite pipelines removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, go, yaml
- Domain
- build-system, ci-cd, testing-qa
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100