-
Notifications
You must be signed in to change notification settings - Fork 522
Re-usable Complement GitHub CI workflow #19533
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
MadLittleMods
merged 15 commits into
develop
from
madlittlemods/reusable-complement-workflow
Apr 13, 2026
Merged
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
34ff702
Re-usable Complement CI workflow
MadLittleMods b6c0721
Add changelog
MadLittleMods 98c9e7b
Set `permissions`
MadLittleMods 5a358eb
Better expression logic
MadLittleMods fa08b98
Try `use_twisted_trunk`
MadLittleMods f4e4152
Try `use_latest_deps`
MadLittleMods 6fcdcd9
Remove extras
MadLittleMods 6d7f13d
Better grammar
MadLittleMods c3fdaf0
Merge branch 'develop' into madlittlemods/reusable-complement-workflow
MadLittleMods 83307e1
Merge branch 'develop' into madlittlemods/reusable-complement-workflow
MadLittleMods 14979d7
Merge branch 'develop' into madlittlemods/reusable-complement-workflow
MadLittleMods d44edf6
Merge branch 'develop' into madlittlemods/reusable-complement-workflow
MadLittleMods 595d939
Merge branch 'develop' into madlittlemods/reusable-complement-workflow
MadLittleMods e1865b4
Merge branch 'develop' into madlittlemods/reusable-complement-workflow
MadLittleMods 02c8ba1
Merge branch 'develop' into madlittlemods/reusable-complement-workflow
MadLittleMods File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| # Re-usable workflow (https://docs.github.com/en/actions/how-tos/reuse-automations/reuse-workflows) | ||
| name: Reusable Complement testing | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| use_latest_deps: | ||
| type: boolean | ||
| default: false | ||
| use_twisted_trunk: | ||
| type: boolean | ||
| default: false | ||
|
|
||
| env: | ||
| RUST_VERSION: 1.87.0 | ||
|
|
||
| jobs: | ||
| complement: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| - arrangement: monolith | ||
| database: SQLite | ||
|
|
||
| - arrangement: monolith | ||
| database: Postgres | ||
|
|
||
| - arrangement: workers | ||
| database: Postgres | ||
|
|
||
| steps: | ||
| - name: Checkout synapse codebase | ||
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
| with: | ||
| path: synapse | ||
|
|
||
| # Log Docker system info for debugging (compare with your local environment) and | ||
| # tracking GitHub runner changes over time (can easily compare a run from last | ||
| # week with the current one in question). | ||
| - run: docker system info | ||
| shell: bash | ||
|
|
||
| - name: Install Rust | ||
| uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9 # master | ||
| with: | ||
| toolchain: ${{ env.RUST_VERSION }} | ||
| - uses: Swatinem/rust-cache@779680da715d629ac1d338a641029a2f4372abb5 # v2.8.2 | ||
|
|
||
| - name: Prepare Complement's Prerequisites | ||
| run: synapse/.ci/scripts/setup_complement_prerequisites.sh | ||
|
|
||
| - uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6.2.0 | ||
| with: | ||
| cache-dependency-path: complement/go.sum | ||
| go-version-file: complement/go.mod | ||
|
|
||
| # This step is specific to the 'Twisted trunk' test run: | ||
| - name: Patch dependencies | ||
| if: ${{ inputs.use_twisted_trunk }} | ||
| run: | | ||
| set -x | ||
| DEBIAN_FRONTEND=noninteractive sudo apt-get install -yqq python3 pipx | ||
| pipx install poetry==2.1.1 | ||
|
|
||
| poetry remove -n twisted | ||
| poetry add -n --extras tls git+https://github.com/twisted/twisted.git#trunk | ||
| poetry lock | ||
| working-directory: synapse | ||
|
|
||
| - name: Run Complement Tests | ||
| id: run_complement_tests | ||
| # -p=1: We're using `-p 1` to force the test packages to run serially as GHA boxes | ||
| # are underpowered and don't like running tons of Synapse instances at once. | ||
| # -json: Output JSON format so that gotestfmt can parse it. | ||
| # | ||
| # tee /tmp/gotest-complement.log: We tee the output to a file so that we can re-process it | ||
| # later on for better formatting with gotestfmt. But we still want the command | ||
| # to output to the terminal as it runs so we can see what's happening in | ||
| # real-time. | ||
| run: | | ||
| set -o pipefail | ||
| COMPLEMENT_DIR=`pwd`/complement synapse/scripts-dev/complement.sh -p 1 -json 2>&1 | tee /tmp/gotest-complement.log | ||
| shell: bash | ||
| env: | ||
| POSTGRES: ${{ (matrix.database == 'Postgres') && 1 || '' }} | ||
| WORKERS: ${{ (matrix.arrangement == 'workers') && 1 || '' }} | ||
| TEST_ONLY_IGNORE_POETRY_LOCKFILE: ${{ inputs.use_latest_deps }} | ||
| TEST_ONLY_SKIP_DEP_HASH_VERIFICATION: ${{ inputs.use_twisted_trunk }} | ||
|
|
||
| - name: Formatted Complement test logs | ||
| # Always run this step if we attempted to run the Complement tests. | ||
| if: always() && steps.run_complement_tests.outcome != 'skipped' | ||
| run: cat /tmp/gotest-complement.log | gotestfmt -hide "successful-downloads,empty-packages" | ||
|
|
||
| - name: Run in-repo Complement Tests | ||
| id: run_in_repo_complement_tests | ||
| # -p=1: We're using `-p 1` to force the test packages to run serially as GHA boxes | ||
| # are underpowered and don't like running tons of Synapse instances at once. | ||
| # -json: Output JSON format so that gotestfmt can parse it. | ||
| # | ||
| # tee /tmp/gotest-in-repo-complement.log: We tee the output to a file so that we can re-process it | ||
| # later on for better formatting with gotestfmt. But we still want the command | ||
| # to output to the terminal as it runs so we can see what's happening in | ||
| # real-time. | ||
| run: | | ||
| set -o pipefail | ||
| COMPLEMENT_DIR=`pwd`/complement synapse/scripts-dev/complement.sh --in-repo -p 1 -json 2>&1 | tee /tmp/gotest-in-repo-complement.log | ||
| shell: bash | ||
| env: | ||
| POSTGRES: ${{ (matrix.database == 'Postgres') && 1 || '' }} | ||
| WORKERS: ${{ (matrix.arrangement == 'workers') && 1 || '' }} | ||
|
|
||
| - name: Formatted in-repo Complement test logs | ||
| # Always run this step if we attempted to run the Complement tests. | ||
| if: always() && steps.run_in_repo_complement_tests.outcome != 'skipped' | ||
| run: cat /tmp/gotest-in-repo-complement.log | gotestfmt -hide "successful-downloads,empty-packages" | ||
|
MadLittleMods marked this conversation as resolved.
Fixed
|
||
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've tried out
use_latest_depsanduse_twisted_trunkin some CI runs and they appear to work. I don't know if the versions are actually being changed as expected.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
twisted_trunk: Updating twisted (25.5.0 -> 25.5.0.post0 508c44f) in the patch dependencies step, seems good
latest_deps: less obvious to see but
#23 [requirements 4/4] RUN --mount=type=cache,target=/root/.cache/uv if [ -z "1" ]; then uvx --with poetry-plugin-export==1.9.0 poetry@2.1.1 export --extras all -o /synapse/requirements.txt ; else touch /synapse/requirements.txt; fi#23 DONE 0.2ssounds like it