Files

182 lines
6.2 KiB
YAML

name: CI
on:
push:
branches: [main]
pull_request:
env:
NODE_ENV: test
DATABASE_URL: postgres://postgres:password@localhost:5432/outline_test
REDIS_URL: redis://127.0.0.1:6379
URL: http://localhost:3000
NODE_OPTIONS: --max-old-space-size=8192
SECRET_KEY: F0E5AD933D7F6FD8F4DBB3E038C501C052DC0593C686D21ACB30AE205D2F634B
UTILS_SECRET: 123456
SLACK_VERIFICATION_TOKEN: 123456
SMTP_USERNAME: localhost
jobs:
changes:
runs-on: ubuntu-latest
outputs:
# Blacksmith runners are only available to the outline organization, and are
# not used for pull requests from forks. They are reserved for the test jobs
# that set the wall time of a CI run.
runner: ${{ (github.repository_owner == 'outline' && (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository)) && 'blacksmith-8vcpu-ubuntu-2404' || 'ubuntu-latest' }}
code: ${{ steps.filter.outputs.code }}
config: ${{ steps.filter.outputs.config }}
server: ${{ steps.filter.outputs.server }}
app: ${{ steps.filter.outputs.app }}
deps: ${{ steps.filter.outputs.deps }}
steps:
- uses: actions/checkout@v5
- uses: dorny/paths-filter@4512585405083f25c027a35db413c2b3b9006d50 # v2
id: filter
with:
filters: |
code:
- '**'
- '!**/*.md'
- '!docs/**'
- '!public/**'
- '!shared/i18n/locales/**'
config:
- '.github/**'
- 'vite.config.mts'
- 'vitest.config.mts'
server:
- 'server/**'
- 'shared/**'
- 'plugins/**'
- 'package.json'
- 'yarn.lock'
app:
- 'app/**'
- 'shared/**'
- 'package.json'
- 'yarn.lock'
deps:
- 'package.json'
- 'yarn.lock'
- '.yarnrc.yml'
lint:
needs: changes
if: ${{ needs.changes.outputs.code == 'true' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: ./.github/actions/install
- run: yarn lint --quiet
actionlint:
needs: changes
if: ${{ needs.changes.outputs.config == 'true' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: docker://rhysd/actionlint:1.7.12
with:
args: -color
types:
needs: changes
if: ${{ needs.changes.outputs.code == 'true' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: ./.github/actions/install
# No tsc build cache persists between runs, so skip writing one.
- run: yarn tsc --incremental false
audit:
needs: changes
if: ${{ needs.changes.outputs.deps == 'true' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: ./.github/actions/install
# Pass when the audit service is unreachable, but still fail on vulnerabilities.
- run: |
set +e
yarn npm audit --severity high --recursive --environment production 2>&1 | tee audit.log
status=${PIPESTATUS[0]}
if [ "$status" -ne 0 ] && grep -qE "RequestError|ETIMEDOUT|ECONNRESET|ECONNREFUSED|EAI_AGAIN|Response Code: 5[0-9]{2}" audit.log; then
echo "::warning::yarn npm audit could not reach the audit service, skipping."
exit 0
fi
exit "$status"
test:
needs: changes
if: ${{ needs.changes.outputs.app == 'true' || needs.changes.outputs.config == 'true' }}
runs-on: ${{ needs.changes.outputs.runner }}
strategy:
matrix:
test-group: [app, shared]
steps:
- uses: actions/checkout@v5
- uses: ./.github/actions/install
- run: yarn test:${{ matrix.test-group }}
test-server:
needs: changes
if: ${{ needs.changes.outputs.server == 'true' || needs.changes.outputs.config == 'true' }}
runs-on: ${{ needs.changes.outputs.runner }}
strategy:
matrix:
shard: [1, 2, 3, 4, 5, 6]
steps:
- uses: actions/checkout@v5
# The runner image ships with PostgreSQL preinstalled, starting it is much
# faster than pulling and initializing a service container.
- name: Start PostgreSQL
run: |
sudo systemctl start postgresql.service
until pg_isready -h localhost; do sleep 1; done
sudo -u postgres psql -c "ALTER USER postgres PASSWORD 'password';"
sudo -u postgres createdb outline_test
- uses: ./.github/actions/install
- run: yarn sequelize db:migrate
- name: Run server tests
run: yarn test:server --maxWorkers=4 --shard=${{ matrix.shard }}/6
bundle-size:
needs: changes
if: ${{ (needs.changes.outputs.app == 'true' || needs.changes.outputs.config == 'true') && github.repository == 'outline/outline' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: ./.github/actions/install
- name: Set environment to production
run: echo "NODE_ENV=production" >> "$GITHUB_ENV"
- run: yarn vite:build
# RelativeCI is an external service, an outage should not block merging.
- name: Send bundle stats to RelativeCI
if: ${{ env.RELATIVE_CI_KEY != '' }}
continue-on-error: true
env:
RELATIVE_CI_KEY: ${{ secrets.RELATIVE_CI_KEY }}
uses: relative-ci/agent-action@38328454d6a23942175eba485fca4fbb807b1f03 # v2
with:
key: ${{ secrets.RELATIVE_CI_KEY }}
token: ${{ secrets.GITHUB_TOKEN }}
webpackStatsFile: ./build/app/webpack-stats.json
# Always runs, so it can be used as the single required status check. Jobs
# above are skipped when irrelevant to the changes, which is a pass here.
# Audit is intentionally excluded, it reports advisories that can have no
# fix available or affect dev only and should not block merging.
ci:
needs: [changes, lint, actionlint, types, test, test-server, bundle-size]
if: always()
runs-on: ubuntu-latest
steps:
- name: Check job results
if: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}
run: |
echo "One or more jobs failed or were cancelled."
exit 1