reset email: change branding to Beeper logo

.github/workflows/beeper-ci.yaml

@@ -0,0 +1,138 @@
+name: Beep
+
+on:
+ push:
+ branches: ["beeper", "beeper-*"]
+ pull_request:
+
+
+jobs:
+ lint-style:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-python@v2
+ - run: pip install poetry
+ - run: poetry install
+ - run: poetry run isort --check synapse
+ - run: poetry run black --check synapse
+
+ lint-types:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-python@v2
+ - run: pip install poetry
+ - run: poetry install --extras all
+ - run: poetry run mypy
+
+ # Tests
+
+ test-trial:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/setup-python@v2
+ - run: pip install poetry
+ - run: poetry install --extras all
+ - run: poetry run trial -j4 tests
+
+ test-sytest:
+ runs-on: ubuntu-latest
+ container:
+ image: matrixdotorg/sytest-synapse:focal
+ volumes:
+ - ${{ github.workspace }}:/src
+ env:
+ SYTEST_BRANCH: 9b80feaa947bce9e181b47362879b0e94d3a9f1d
+ TOP: ${{ github.workspace }}
+ POSTGRES: 1
+ MULTI_POSTGRES: 1
+ WOKRERS: 1
+ steps:
+ - uses: actions/checkout@v2
+ - name: Run SyTest
+ run: /bootstrap.sh synapse
+ working-directory: /src
+ - name: Summarise results.tap
+ if: ${{ always() }}
+ run: /sytest/scripts/tap_to_gha.pl /logs/results.tap
+ - name: Upload SyTest logs
+ uses: actions/upload-artifact@v2
+ if: ${{ always() }}
+ with:
+ name: Sytest Logs - ${{ job.status }} - (${{ join(matrix.*, ', ') }})
+ path: |
+ /logs/results.tap
+ /logs/**/*.log*
+
+ test-complement:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/checkout@v2
+ with:
+ repository: matrix-org/complement
+ path: complement
+ ref: 8587fb3cbe746754b2c883ff6c818ca4d987d0a5
+ - name: Install complement dependencies
+ run: |-
+ sudo apt-get -qq update
+ sudo apt-get install -qqy libolm3 libolm-dev
+ go install -v github.com/gotesttools/gotestfmt/v2/cmd/gotestfmt@latest
+ - name: Run Complement
+ run: ./scripts-dev/complement.sh
+ env:
+ COMPLEMENT_DIR: complement
+
+ # Builds
+
+ build-python:
+ runs-on: ubuntu-latest
+ env:
+ DOCKER_BUILDKIT: 1
+ steps:
+ - uses: actions/checkout@v2
+ - uses: docker/setup-qemu-action@v2
+ - uses: docker/setup-buildx-action@v2
+ with:
+ # TEMPORARY, see: https:/docker/build-push-action/issues/761
+ driver-opts: |
+ image=moby/buildkit:v0.10.6
+ - uses: docker/login-action@v2
+ with:
+ registry: ${{ secrets.CI_REGISTRY }}
+ username: ${{ secrets.CI_REGISTRY_USER }}
+ password: ${{ secrets.CI_REGISTRY_PASSWORD }}
+ - run: |-
+ if [ "${{ github.ref_name }}" = "beeper" ]; then
+ tag=$(cat pyproject.toml | grep -E "^version =" | sed -E 's/^version = "(.+)"$/\1/')
+ else
+ tag="${{ github.head_ref || github.ref_name }}"
+ fi
+
+ docker buildx build \
+ --push \
+ --platform linux/amd64 \
+ --tag ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }} \
+ -f docker/Dockerfile \
+ .
+
+ if [ "${{ github.ref_name }}" = "beeper" ]; then
+ docker pull ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }}
+ docker tag \
+ ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }} \
+ ${{ secrets.CI_REGISTRY }}/synapse:latest
+ docker push ${{ secrets.CI_REGISTRY }}/synapse:latest
+ fi
+
+ # Ensure the image works properly
+ docker run \
+ --entrypoint '' \
+ ${{ secrets.CI_REGISTRY }}/synapse:$tag-${{ github.sha }} \
+ python -m synapse.app.homeserver --help
+
+ echo "Pushed image: synapse:$tag-${{ github.sha }}"
+ if [ "${{ github.ref_name }}" = "beeper" ]; then
+ echo "Pushed image: synapse:latest"
+ fi

README.md

@@ -0,0 +1,38 @@
+# Synapse: Beeper Edition
+
+
+## Rebase flow
+
+### Create PR
+
+Here we're upgrading to `v1.96.1`:
+
+```
+# Make a new branch from the upstream release, we do this so we can create a PR
+# of Beeper -> upstream to run tests/confirm we're happy.
+git checkout -f v1.96.1
+git checkout -b upstream-1.96.1
+git push -u beeper upstream-1.96.1
+
+# Check out the base branch, pull any changes
+git checkout beeper
+git pull
+
+# Now create a new branch to rebase
+git checkout -b beeper-1.96.1
+# And do the rebase
+git rebase v1.96.1
+# fix any conflicts...
+
+# Push and make a PR from this branch to the upstream one created above
+git push -u beeper beeper-1.96.1
+```
+
+### Make release
+
+Once it's ready we just overwrite the `beeper` branch with the new one:
+
+```
+git checkout beeper-1.96.1
+git push --force beeper beeper
+```

beeper/complete_release.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+source $(realpath $(dirname $0))/utils.sh
+
+BEEPER_REMOTE=$(get_beeper_remote)
+
+VERSION=${1:-}
+
+if [ -z "$VERSION" ]; then
+ echo >&2 "Must specify version!"
+ exit 1
+fi
+
+echo "Completing Synapse: Beeper Edition version $VERSION"
+echo "WARNING: this script will DELETE the branch called: beeper"
+read -p "Press enter to continue"
+
+UPSTREAM_BRANCH=upstream-$VERSION
+BEEPER_BRANCH=beeper-$VERSION
+
+git checkout $BEEPER_BRANCH
+git branch -D beeper
+git checkout -b beeper
+git push --force $BEEPER_REMOTE beeper
+
+# Cleanup
+git branch -D $BEEPER_BRANCH
+git push $BEEPER_REMOTE --delete $BEEPER_BRANCH
+git branch -D $UPSTREAM_BRANCH
+git push $BEEPER_REMOTE --delete $UPSTREAM_BRANCH

beeper/prepare_release.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+source $(realpath $(dirname $0))/utils.sh
+
+BEEPER_REMOTE=$(get_beeper_remote)
+
+VERSION=${1:-}
+
+if [ -z "$VERSION" ]; then
+ echo >&2 "Must specify version!"
+ exit 1
+fi
+
+STARTING_BRANCH=$(git branch --show-current)
+
+echo "Preparing Synapse: Beeper Edition version $VERSION"
+echo "WARNING: this script will rebase on top of the CURRENT BRANCH: $STARTING_BRANCH"
+read -p "Press enter to continue"
+
+TAG=v$VERSION
+UPSTREAM_BRANCH=upstream-$VERSION
+BEEPER_BRANCH=beeper-$VERSION
+
+# Checkout the tag, create upstream branch, push it
+echo "Setup branch $UPSTREAM_BRANCH"
+git checkout -f $TAG
+git checkout -b $UPSTREAM_BRANCH
+git push -u $BEEPER_REMOTE $UPSTREAM_BRANCH
+
+# Switch back to our starting branch, create new version branch from it
+echo "Setup branch $BEEPER_BRANCH"
+git checkout $STARTING_BRANCH
+git checkout -b $BEEPER_BRANCH
+
+# And rebase against upstream, applying only our Beeper commits
+echo "Initiate rebase..."
+git rebase $UPSTREAM_BRANCH || read -p "Rebase was a mess, press enter once you fix it"
+
+git push -u $BEEPER_REMOTE $BEEPER_BRANCH
+
+echo "OK we done!"
+echo "Go HERE and make the PR: https:/beeper/synapse/compare/upstream-$VERSION...beeper-$VERSION?expand=1"

beeper/utils.sh

@@ -0,0 +1,23 @@
+function get_upstream_remote() {
+ for remote in $(git remote); do
+ url=$(git remote get-url $remote)
+ if [ "$url" = "[email protected]:element-hq/synapse.git" ]; then
+ echo $remote
+ return 0
+ fi
+ done
+ echo >&2 "No upstream remote found (looking for URL: [email protected]:element-hq/synapse.git)"
+ return 1
+}
+
+function get_beeper_remote() {
+ for remote in $(git remote); do
+ url=$(git remote get-url $remote)
+ if [ "$url" = "[email protected]:beeper/synapse.git" ]; then
+ echo $remote
+ return 0
+ fi
+ done
+ echo >&2 "No upstream remote found (looking for URL: [email protected]:beeper/synapse.git)"
+ return 1
+}

docker/Dockerfile

@@ -134,6 +134,10 @@ COPY --from=requirements /synapse/requirements.txt /synapse/
 RUN --mount=type=cache,target=/root/.cache/pip \
  pip install --prefix="/install" --no-deps --no-warn-script-location -r /synapse/requirements.txt
 
+# Beeper: install shared secret authenticator
+RUN pip install --prefix="/install" --no-deps --no-warn-script-location \
+ 'git+https:/devture/matrix-synapse-shared-secret-auth@e178353ec87c56e0169dd04466d4769da5ed9c46#egg=shared_secret_authenticator'
+
 # Copy over the rest of the synapse source code.
 COPY synapse /synapse/synapse/
 COPY rust /synapse/rust/