matrix-org / backend-meta

CI config shared between matrix.org backend projects.

This repository contains reusable workflows for use by the Synapse team.

The intent is to keep our various projects' CI configuration consistent without having to update N yaml files across N repositories.

Releases

We follow GitHub's advice for versioning actions. In short:

• Use semver release numbering.
• Test changes by publishing them to a named branch, and have test consumers cite that branch.
• For each major version 1, 2, ...:
  • Maintain branches release/v1, release/v2 which track development of a release.
  • From these branches, cut releases 1.x.y, 2.x.y as needed. Tag as v1.x.y etc.
  • Maintain a tag v1, v2, ... which points to the latest release in the 1.x, 2.x series. These tags will need to be force-recreated and force-pushed.
• Consumers that trust this repo should use tagged major versions (v1, v2,...) of these workflows.
• Consumers that don't should use specify a commit hash when using a workflow.

backend-meta's Issues

sign-off workflow doesn't ignore requirement for org members without write access

See #9

Shouldn't the check have exempted you as a member of the matrix-org org?

Nope, because GitHub's author_association is a bit rubbish. It doesn't appear to be org aware, but that's fine so long as you don't make a PR from a fork. I still need to figure out how to make this work for people who are in the org, but do not have write access.

Sign-off workflow doesn't like hyphens in names

(Pretty sure my diagnosis is right, eyeballing the regex that the script uses)

See e.g. matrix-org/complement#622 (comment) for example

Cache and restore `black`'s cache directory

Synapse spends 20 seconds running black. Might be able to trim this down.

Black's cache dir can be set using the env var BLACK_CACHE_DIR, see https://black.readthedocs.io/en/stable/usage_and_configuration/file_collection_and_discovery.html.