Skip to content

WIP: Specify Content-Disposition and Content-Type semantics on /download and /thumbnail #2167

WIP: Specify Content-Disposition and Content-Type semantics on /download and /thumbnail

WIP: Specify Content-Disposition and Content-Type semantics on /download and /thumbnail #2167

Workflow file for this run

name: "Spec"
on:
push:
branches:
- main
tags:
- v*
pull_request:
workflow_dispatch:
schedule:
# Run this workflow every day at 2am. This helps keep the page of
# current spec proposals up-to-date.
- cron: '0 2 * * *'
jobs:
validate-openapi:
name: "πŸ”Ž Validate OpenAPI specifications"
runs-on: ubuntu-latest
steps:
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v4
- name: "βž• Setup Node"
uses: actions/setup-node@v3
with:
node-version: '18'
- name: "πŸ”Ž Run validator"
run: |
npx @redocly/cli@latest lint data/api/*/*.yaml
check-event-examples:
name: "πŸ”Ž Check Event schema examples"
runs-on: ubuntu-latest
steps:
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v4
- name: "βž• Setup Python"
uses: actions/setup-python@v4
with:
python-version: '3.9'
cache: 'pip'
cache-dependency-path: scripts/requirements.txt
- name: "βž• Install dependencies"
run: |
pip install -r scripts/requirements.txt
- name: "πŸ”Ž Run validator"
run: |
python scripts/check-event-schema-examples.py
check-openapi-examples:
name: "πŸ”Ž Check OpenAPI definitions examples"
runs-on: ubuntu-latest
steps:
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v2
- name: "βž• Setup Python"
uses: actions/setup-python@v4
with:
python-version: '3.9'
cache: 'pip'
cache-dependency-path: scripts/requirements.txt
- name: "βž• Install dependencies"
run: |
pip install -r scripts/requirements.txt
- name: "πŸ”Ž Run validator"
run: |
python scripts/check-openapi-sources.py
check-schemas-examples:
name: "πŸ”Ž Check JSON Schemas inline examples"
runs-on: ubuntu-latest
steps:
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v2
- name: "βž• Setup Python"
uses: actions/setup-python@v4
with:
python-version: '3.9'
cache: 'pip'
cache-dependency-path: scripts/requirements.txt
- name: "βž• Install dependencies"
run: |
pip install -r scripts/requirements.txt
- name: "πŸ”Ž Run validator"
run: |
python scripts/check-json-schemas.py
calculate-baseurl:
name: "βš™οΈ Calculate baseURL for later jobs"
runs-on: ubuntu-latest
outputs:
baseURL: "${{ steps.set-baseurl.outputs.baseURL }}"
steps:
# For PRs, set the baseURL to `/`.
# For releases, set the baseURL to `/$tag` (eg: `/v1.2`).
# Otherwise, set it to `/unstable`.
- name: "βš™οΈ Calculate baseURL"
id: set-baseurl
# Double brackets on the elif to avoid auto-escaping refs/tags/* because we need
# the asterisk matching behaviour, not the literal string.
run: |
if [ "${GITHUB_EVENT_NAME}" == "pull_request" ]; then
echo ::set-output name=baseURL::/
elif [[ "${GITHUB_REF}" == refs/tags/* ]]; then
echo ::set-output name=baseURL::"/${GITHUB_REF/refs\/tags\//}"
else
echo ::set-output name=baseURL::/unstable
fi
build-openapi:
name: "🐍 Build OpenAPI definitions"
runs-on: ubuntu-latest
needs: [calculate-baseurl]
steps:
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v4
- name: "βž• Setup Python"
uses: actions/setup-python@v4
with:
python-version: '3.9'
cache: 'pip'
cache-dependency-path: scripts/requirements.txt
- name: "βž• Install dependencies"
run: |
pip install -r scripts/requirements.txt
- name: "πŸ“¦ Asset creation"
run: |
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
export RELEASE="${GITHUB_REF/refs\/tags\//}"
else
export RELEASE="unstable"
fi
# The output path matches the final deployment path at spec.matrix.org
scripts/dump-openapi.py \
--base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
--api application-service \
-r "$RELEASE" \
-o spec/application-service-api/api.json
scripts/dump-openapi.py \
--base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
--api client-server \
-r "$RELEASE" \
-o spec/client-server-api/api.json
scripts/dump-openapi.py \
--base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
--api push-gateway \
-r "$RELEASE" \
-o spec/push-gateway-api/api.json
scripts/dump-openapi.py \
--base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
--api server-server \
-r "$RELEASE" \
-o spec/server-server-api/api.json
tar -czf openapi.tar.gz spec
- name: "πŸ“€ Artifact upload"
uses: actions/upload-artifact@v3
with:
name: openapi-artifact
path: openapi.tar.gz
generate-changelog:
name: "πŸ“’ Run towncrier for changelog"
# skip for builds of git tags
if: "!startsWith(github.ref, 'refs/tags/')"
runs-on: ubuntu-latest
steps:
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v4
- name: "βž• Setup Python"
uses: actions/setup-python@v4
- name: "βž• Install towncrier"
run: "pip install 'towncrier'"
- name: "Generate changelog"
run: ./scripts/generate-changelog.sh vUNSTABLE
- name: "πŸ“€ Artifact upload"
uses: actions/upload-artifact@v3
with:
name: changelog-artifact
path: content/changelog/vUNSTABLE.md
build-spec:
name: "πŸ“– Build the spec"
runs-on: ubuntu-latest
needs: [calculate-baseurl, build-openapi, generate-changelog]
# run even if generate-changelog was skipped
if: ${{ always() }}
steps:
- name: "βž• Setup Node"
uses: actions/setup-node@v3
with:
node-version: '18'
- name: "βž• Setup Hugo"
uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d
with:
hugo-version: '0.113.0'
extended: true
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v4
- name: "βš™οΈ npm"
run: |
npm i
npm run get-proposals
- name: "πŸ“₯ Download generated changelog"
if: "needs.generate-changelog.result == 'success'"
uses: actions/download-artifact@v3
with:
name: changelog-artifact
path: content/changelog
- name: "βš™οΈ hugo"
run: hugo --baseURL "${{ needs.calculate-baseurl.outputs.baseURL }}" -d "spec"
# We manually unpack the spec OpenAPI definition JSON to the website tree
# to make it available to the world in a canonical place:
# https://spec.matrix.org/latest/client-server-api/api.json
# Works for /unstable/ and /v1.1/ as well.
- name: "πŸ“₯ Spec definition download"
uses: actions/download-artifact@v3
with:
name: openapi-artifact
- name: "πŸ“ Unpack the OpenAPI definitions in the right location"
run: |
tar -xzf openapi.tar.gz
- name: "πŸ“¦ Tarball creation"
run: tar -czf spec.tar.gz spec
- name: "πŸ“€ Artifact upload"
uses: actions/upload-artifact@v3
with:
name: spec-artifact
path: spec.tar.gz
htmlcheck:
name: "πŸ”Ž Validate generated HTML"
runs-on: ubuntu-latest
needs: [calculate-baseurl, build-spec]
steps:
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v4
- name: "πŸ“₯ Fetch built spec"
uses: actions/download-artifact@v3
with:
name: spec-artifact
- name: "πŸ“ Unpack the spec"
# we have to unpack it into the right path given the baseurl, so that the
# links are correct.
# eg if baseurl is `/unstable`, we want to put the site in `spec/unstable`.
run: |
mkdir -p "spec${baseURL}"
tar -C "spec${baseURL}" --strip-components=1 -xvzf spec.tar.gz
env:
baseURL: "${{ needs.calculate-baseurl.outputs.baseURL }}"
- name: "Run htmltest"
uses: wjdp/htmltest-action@master
with:
config: .htmltest.yaml
build-historical-spec:
name: "πŸ“– Build the historical backup spec"
runs-on: ubuntu-latest
needs: [build-openapi]
if: ${{ startsWith(github.ref, 'refs/tags/') }}
steps:
- name: "βž• Setup Node"
uses: actions/setup-node@v3
with:
node-version: '18'
- name: "βž• Setup Hugo"
uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d
with:
hugo-version: '0.93.3'
extended: true
- name: "πŸ“₯ Source checkout"
uses: actions/checkout@v4
- name: "βš™οΈ npm"
run: |
npm i
npm run get-proposals
- name: "βš™οΈ hugo"
# Create a baseURL like `/v1.2` out of the `v1.2` tag
run: |
echo -e '[params.version]\nstatus="historical"' > historical.toml
hugo --config config.toml,historical.toml --baseURL "/${GITHUB_REF/refs\/tags\//}" -d "spec"
- name: "πŸ“₯ Spec definition download"
uses: actions/download-artifact@v3
with:
name: openapi-artifact
- name: "πŸ“ Unpack the OpenAPI definitions in the right location"
run: |
tar -xzf openapi.tar.gz
- name: "πŸ“¦ Tarball creation"
run: tar -czf spec-historical.tar.gz spec
- name: "πŸ“€ Artifact upload"
uses: actions/upload-artifact@v3
with:
name: spec-historical-artifact
path: spec-historical.tar.gz