mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-09-26 01:12:43 -05:00
994 lines
38 KiB
YAML
994 lines
38 KiB
YAML
name: ci
|
|
on:
|
|
push:
|
|
tags:
|
|
# https://semver.org/#spec-item-2
|
|
- 'v[0-9]+.[0-9]+.[0-9]+'
|
|
# https://semver.org/#spec-item-9
|
|
- 'v[0-9]+.[0-9]+.[0-9]+-beta.rc[0-9]+'
|
|
branches-ignore:
|
|
- 'translations**'
|
|
pull_request:
|
|
branches-ignore:
|
|
- 'translations**'
|
|
env:
|
|
DEFAULT_UV_VERSION: "0.8.x"
|
|
# This is the default version of Python to use in most steps which aren't specific
|
|
DEFAULT_PYTHON_VERSION: "3.11"
|
|
NLTK_DATA: "/usr/share/nltk_data"
|
|
jobs:
|
|
detect-duplicate:
|
|
name: Detect Duplicate Run
|
|
runs-on: ubuntu-24.04
|
|
outputs:
|
|
should_run: ${{ steps.check.outputs.should_run }}
|
|
steps:
|
|
- name: Check if workflow should run
|
|
id: check
|
|
uses: actions/github-script@v7
|
|
with:
|
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
script: |
|
|
if (context.eventName !== 'push') {
|
|
core.info('Not a push event; running workflow.');
|
|
core.setOutput('should_run', 'true');
|
|
return;
|
|
}
|
|
|
|
const ref = context.ref || '';
|
|
if (!ref.startsWith('refs/heads/')) {
|
|
core.info('Push is not to a branch; running workflow.');
|
|
core.setOutput('should_run', 'true');
|
|
return;
|
|
}
|
|
|
|
const branch = ref.substring('refs/heads/'.length);
|
|
const { owner, repo } = context.repo;
|
|
const prs = await github.paginate(github.rest.pulls.list, {
|
|
owner,
|
|
repo,
|
|
state: 'open',
|
|
head: `${owner}:${branch}`,
|
|
per_page: 100,
|
|
});
|
|
|
|
if (prs.length === 0) {
|
|
core.info(`No open PR found for ${branch}; running workflow.`);
|
|
core.setOutput('should_run', 'true');
|
|
} else {
|
|
core.info(`Found ${prs.length} open PR(s) for ${branch}; skipping duplicate push run.`);
|
|
core.setOutput('should_run', 'false');
|
|
}
|
|
pre-commit:
|
|
needs:
|
|
- detect-duplicate
|
|
if: needs.detect-duplicate.outputs.should_run == 'true'
|
|
name: Linting Checks
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v5
|
|
- name: Install python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
|
- name: Check files
|
|
uses: pre-commit/action@v3.0.1
|
|
documentation:
|
|
name: "Build & Deploy Documentation"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- pre-commit
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
- name: Set up Python
|
|
id: setup-python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v6
|
|
with:
|
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
|
enable-cache: true
|
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
|
- name: Install Python dependencies
|
|
run: |
|
|
uv sync --python ${{ steps.setup-python.outputs.python-version }} --dev --frozen
|
|
- name: Make documentation
|
|
run: |
|
|
uv run \
|
|
--python ${{ steps.setup-python.outputs.python-version }} \
|
|
--dev \
|
|
--frozen \
|
|
mkdocs build --config-file ./mkdocs.yml
|
|
- name: Deploy documentation
|
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
|
run: |
|
|
echo "docs.paperless-ngx.com" > "${{ github.workspace }}/docs/CNAME"
|
|
git config --global user.name "${{ github.actor }}"
|
|
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
|
|
uv run \
|
|
--python ${{ steps.setup-python.outputs.python-version }} \
|
|
--dev \
|
|
--frozen \
|
|
mkdocs gh-deploy --force --no-history
|
|
- name: Upload artifact
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: documentation
|
|
path: site/
|
|
retention-days: 7
|
|
tests-backend:
|
|
name: "Backend Tests (Python ${{ matrix.python-version }})"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- pre-commit
|
|
strategy:
|
|
matrix:
|
|
python-version: ['3.10', '3.11', '3.12']
|
|
fail-fast: false
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
- name: Start containers
|
|
run: |
|
|
docker compose --file ${{ github.workspace }}/docker/compose/docker-compose.ci-test.yml pull --quiet
|
|
docker compose --file ${{ github.workspace }}/docker/compose/docker-compose.ci-test.yml up --detach
|
|
- name: Set up Python
|
|
id: setup-python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "${{ matrix.python-version }}"
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v6
|
|
with:
|
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
|
enable-cache: true
|
|
python-version: ${{ steps.setup-python.outputs.python-version }}
|
|
- name: Install system dependencies
|
|
run: |
|
|
sudo apt-get update -qq
|
|
sudo apt-get install -qq --no-install-recommends unpaper tesseract-ocr imagemagick ghostscript libzbar0 poppler-utils
|
|
- name: Configure ImageMagick
|
|
run: |
|
|
sudo cp docker/rootfs/etc/ImageMagick-6/paperless-policy.xml /etc/ImageMagick-6/policy.xml
|
|
- name: Install Python dependencies
|
|
run: |
|
|
uv sync \
|
|
--python ${{ steps.setup-python.outputs.python-version }} \
|
|
--group testing \
|
|
--frozen
|
|
- name: List installed Python dependencies
|
|
run: |
|
|
uv pip list
|
|
- name: Install or update NLTK dependencies
|
|
run: uv run python -m nltk.downloader punkt punkt_tab snowball_data stopwords -d ${{ env.NLTK_DATA }}
|
|
- name: Tests
|
|
env:
|
|
NLTK_DATA: ${{ env.NLTK_DATA }}
|
|
PAPERLESS_CI_TEST: 1
|
|
# Enable paperless_mail testing against real server
|
|
PAPERLESS_MAIL_TEST_HOST: ${{ secrets.TEST_MAIL_HOST }}
|
|
PAPERLESS_MAIL_TEST_USER: ${{ secrets.TEST_MAIL_USER }}
|
|
PAPERLESS_MAIL_TEST_PASSWD: ${{ secrets.TEST_MAIL_PASSWD }}
|
|
run: |
|
|
uv run \
|
|
--python ${{ steps.setup-python.outputs.python-version }} \
|
|
--dev \
|
|
--frozen \
|
|
pytest
|
|
- name: Upload backend test results to Codecov
|
|
if: always()
|
|
uses: codecov/test-results-action@v1
|
|
with:
|
|
token: ${{ secrets.CODECOV_TOKEN }}
|
|
flags: backend-python-${{ matrix.python-version }}
|
|
files: junit.xml
|
|
- name: Upload backend coverage to Codecov
|
|
uses: codecov/codecov-action@v5
|
|
with:
|
|
token: ${{ secrets.CODECOV_TOKEN }}
|
|
flags: backend-python-${{ matrix.python-version }}
|
|
files: coverage.xml
|
|
- name: Stop containers
|
|
if: always()
|
|
run: |
|
|
docker compose --file ${{ github.workspace }}/docker/compose/docker-compose.ci-test.yml logs
|
|
docker compose --file ${{ github.workspace }}/docker/compose/docker-compose.ci-test.yml down
|
|
install-frontend-dependencies:
|
|
name: "Install Frontend Dependencies"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- pre-commit
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
- name: Install pnpm
|
|
uses: pnpm/action-setup@v4
|
|
with:
|
|
version: 10
|
|
- name: Use Node.js 20
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 20.x
|
|
cache: 'pnpm'
|
|
cache-dependency-path: 'src-ui/pnpm-lock.yaml'
|
|
- name: Cache frontend dependencies
|
|
id: cache-frontend-deps
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.pnpm-store
|
|
~/.cache
|
|
key: ${{ runner.os }}-frontenddeps-${{ hashFiles('src-ui/pnpm-lock.yaml') }}
|
|
- name: Install dependencies
|
|
run: cd src-ui && pnpm install
|
|
tests-frontend:
|
|
name: "Frontend Unit Tests (Node ${{ matrix.node-version }} - ${{ matrix.shard-index }}/${{ matrix.shard-count }})"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- install-frontend-dependencies
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
node-version: [20.x]
|
|
shard-index: [1, 2, 3, 4]
|
|
shard-count: [4]
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
- name: Install pnpm
|
|
uses: pnpm/action-setup@v4
|
|
with:
|
|
version: 10
|
|
- name: Use Node.js 20
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 20.x
|
|
cache: 'pnpm'
|
|
cache-dependency-path: 'src-ui/pnpm-lock.yaml'
|
|
- name: Cache frontend dependencies
|
|
id: cache-frontend-deps
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.pnpm-store
|
|
~/.cache
|
|
key: ${{ runner.os }}-frontenddeps-${{ hashFiles('src-ui/pnpm-lock.yaml') }}
|
|
- name: Re-link Angular cli
|
|
run: cd src-ui && pnpm link @angular/cli
|
|
- name: Linting checks
|
|
run: cd src-ui && pnpm run lint
|
|
- name: Run Jest unit tests
|
|
run: cd src-ui && pnpm run test --max-workers=2 --shard=${{ matrix.shard-index }}/${{ matrix.shard-count }}
|
|
- name: Upload frontend test results to Codecov
|
|
uses: codecov/test-results-action@v1
|
|
if: always()
|
|
with:
|
|
token: ${{ secrets.CODECOV_TOKEN }}
|
|
flags: frontend-node-${{ matrix.node-version }}
|
|
directory: src-ui/
|
|
- name: Upload frontend coverage to Codecov
|
|
uses: codecov/codecov-action@v5
|
|
with:
|
|
token: ${{ secrets.CODECOV_TOKEN }}
|
|
flags: frontend-node-${{ matrix.node-version }}
|
|
directory: src-ui/coverage/
|
|
tests-frontend-e2e:
|
|
name: "Frontend E2E Tests (Node ${{ matrix.node-version }} - ${{ matrix.shard-index }}/${{ matrix.shard-count }})"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- install-frontend-dependencies
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
node-version: [20.x]
|
|
shard-index: [1, 2]
|
|
shard-count: [2]
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
- name: Install pnpm
|
|
uses: pnpm/action-setup@v4
|
|
with:
|
|
version: 10
|
|
- name: Use Node.js 20
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 20.x
|
|
cache: 'pnpm'
|
|
cache-dependency-path: 'src-ui/pnpm-lock.yaml'
|
|
- name: Cache frontend dependencies
|
|
id: cache-frontend-deps
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.pnpm-store
|
|
~/.cache
|
|
key: ${{ runner.os }}-frontenddeps-${{ hashFiles('src-ui/pnpm-lock.yaml') }}
|
|
- name: Re-link Angular cli
|
|
run: cd src-ui && pnpm link @angular/cli
|
|
- name: Cache Playwright browsers
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: ~/.cache/ms-playwright
|
|
key: ${{ runner.os }}-playwright-${{ hashFiles('src-ui/pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-playwright-
|
|
- name: Install Playwright system dependencies
|
|
run: npx playwright install-deps
|
|
- name: Install dependencies
|
|
run: cd src-ui && pnpm install --no-frozen-lockfile
|
|
- name: Install Playwright
|
|
run: cd src-ui && pnpm exec playwright install
|
|
- name: Run Playwright e2e tests
|
|
run: cd src-ui && pnpm exec playwright test --shard ${{ matrix.shard-index }}/${{ matrix.shard-count }}
|
|
codecov-comment:
|
|
name: "Codecov PR Comment"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- tests-backend
|
|
- tests-frontend
|
|
- tests-frontend-e2e
|
|
if: github.event_name == 'pull_request'
|
|
permissions:
|
|
contents: read
|
|
pull-requests: write
|
|
steps:
|
|
- name: Gather pull request context
|
|
id: pr
|
|
uses: actions/github-script@v7
|
|
with:
|
|
script: |
|
|
const pr = context.payload.pull_request;
|
|
if (!pr) {
|
|
core.info('No associated pull request. Skipping.');
|
|
core.setOutput('shouldRun', 'false');
|
|
return;
|
|
}
|
|
|
|
core.setOutput('shouldRun', 'true');
|
|
core.setOutput('prNumber', pr.number.toString());
|
|
core.setOutput('headSha', pr.head.sha);
|
|
- name: Fetch Codecov coverage
|
|
id: coverage
|
|
if: steps.pr.outputs.shouldRun == 'true'
|
|
uses: actions/github-script@v7
|
|
env:
|
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
|
COMMIT_SHA: ${{ steps.pr.outputs.headSha }}
|
|
PR_NUMBER: ${{ steps.pr.outputs.prNumber }}
|
|
with:
|
|
script: |
|
|
const token = process.env.CODECOV_TOKEN;
|
|
if (!token) {
|
|
core.warning('CODECOV_TOKEN secret is not available; skipping comment.');
|
|
core.setOutput('shouldComment', 'false');
|
|
return;
|
|
}
|
|
|
|
const commitSha = process.env.COMMIT_SHA;
|
|
const prNumber = process.env.PR_NUMBER;
|
|
const owner = context.repo.owner;
|
|
const repo = context.repo.repo;
|
|
const service = 'gh';
|
|
const baseUrl = `https://api.codecov.io/api/v2/${service}/${owner}/repos/${repo}`;
|
|
const commitUrl = `${baseUrl}/commits/${commitSha}`;
|
|
const maxAttempts = 20;
|
|
const waitMs = 15000;
|
|
const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
|
|
|
|
let data;
|
|
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
|
|
core.info(`Fetching Codecov report (attempt ${attempt}/${maxAttempts})`);
|
|
let response;
|
|
try {
|
|
response = await fetch(commitUrl, {
|
|
headers: {
|
|
Authorization: `Bearer ${token}`,
|
|
'Content-Type': 'application/json',
|
|
Accept: 'application/json',
|
|
},
|
|
});
|
|
} catch (error) {
|
|
core.warning(`Codecov fetch failed: ${error}. Waiting before retrying.`);
|
|
await sleep(waitMs);
|
|
continue;
|
|
}
|
|
|
|
if (response.status === 404) {
|
|
core.info('Report not ready yet (404). Waiting before retrying.');
|
|
await sleep(waitMs);
|
|
continue;
|
|
}
|
|
|
|
if ([429, 500, 502, 503, 504].includes(response.status)) {
|
|
const text = await response.text().catch(() => '');
|
|
core.info(`Codecov API transient error ${response.status}: ${text}. Waiting before retrying.`);
|
|
await sleep(waitMs);
|
|
continue;
|
|
}
|
|
|
|
if (!response.ok) {
|
|
const text = await response.text().catch(() => '');
|
|
core.warning(`Codecov API returned ${response.status}: ${text}. Skipping comment.`);
|
|
core.setOutput('shouldComment', 'false');
|
|
return;
|
|
}
|
|
|
|
data = await response.json().catch((error) => {
|
|
core.warning(`Failed to parse Codecov response: ${error}.`);
|
|
return undefined;
|
|
});
|
|
if (data && Object.keys(data).length > 0) {
|
|
break;
|
|
}
|
|
|
|
core.info('Report payload empty. Waiting before retrying.');
|
|
await sleep(waitMs);
|
|
}
|
|
|
|
if (!data && prNumber) {
|
|
core.info('Attempting to retrieve coverage from PR endpoint.');
|
|
const prUrl = `${baseUrl}/pulls/${prNumber}`;
|
|
let prResponse;
|
|
try {
|
|
prResponse = await fetch(prUrl, {
|
|
headers: {
|
|
Authorization: `Bearer ${token}`,
|
|
'Content-Type': 'application/json',
|
|
Accept: 'application/json',
|
|
},
|
|
});
|
|
} catch (error) {
|
|
core.warning(`Codecov PR fetch failed: ${error}.`);
|
|
}
|
|
|
|
if (prResponse) {
|
|
if ([429, 500, 502, 503, 504].includes(prResponse.status)) {
|
|
const text = await prResponse.text().catch(() => '');
|
|
core.info(`Codecov PR endpoint transient error ${prResponse.status}: ${text}.`);
|
|
} else if (!prResponse.ok) {
|
|
const text = await prResponse.text().catch(() => '');
|
|
core.warning(`Codecov PR endpoint returned ${prResponse.status}: ${text}.`);
|
|
} else {
|
|
const prData = await prResponse.json().catch((error) => {
|
|
core.warning(`Failed to parse Codecov PR response: ${error}.`);
|
|
return undefined;
|
|
});
|
|
|
|
if (prData?.latest_report) {
|
|
data = { report: prData.latest_report };
|
|
} else if (prData?.head_totals) {
|
|
const headTotals = prData.head_totals;
|
|
const baseTotals = prData.base_totals;
|
|
let compareTotals;
|
|
if (baseTotals && headTotals) {
|
|
const headCoverage = Number(headTotals.coverage);
|
|
const baseCoverage = Number(baseTotals.coverage);
|
|
if (Number.isFinite(headCoverage) && Number.isFinite(baseCoverage)) {
|
|
compareTotals = {
|
|
base_coverage: baseCoverage,
|
|
coverage_change: headCoverage - baseCoverage,
|
|
};
|
|
}
|
|
}
|
|
|
|
data = {
|
|
report: {
|
|
totals: headTotals,
|
|
compare: compareTotals ? { totals: compareTotals } : undefined,
|
|
totals_by_flag: [],
|
|
},
|
|
head_totals: headTotals,
|
|
base_totals: baseTotals,
|
|
};
|
|
} else {
|
|
data = prData;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!data) {
|
|
core.warning('Unable to retrieve Codecov report after multiple attempts.');
|
|
core.setOutput('shouldComment', 'false');
|
|
return;
|
|
}
|
|
|
|
const toNumber = (value) => {
|
|
if (value === null || value === undefined || value === '') {
|
|
return undefined;
|
|
}
|
|
const num = Number(value);
|
|
return Number.isFinite(num) ? num : undefined;
|
|
};
|
|
|
|
const reportData = data.report || data;
|
|
const totals = reportData.totals ?? data.head_totals ?? data.totals;
|
|
if (!totals) {
|
|
core.warning('Codecov response does not contain coverage totals.');
|
|
core.setOutput('shouldComment', 'false');
|
|
return;
|
|
}
|
|
|
|
let compareTotals = reportData.compare?.totals ?? data.compare?.totals;
|
|
if (!compareTotals && data.base_totals) {
|
|
const baseCoverageValue = toNumber(data.base_totals.coverage);
|
|
if (baseCoverageValue !== undefined) {
|
|
const headCoverageValue = toNumber((data.head_totals ?? {}).coverage);
|
|
compareTotals = {
|
|
base_coverage: baseCoverageValue,
|
|
coverage_change:
|
|
headCoverageValue !== undefined ? headCoverageValue - baseCoverageValue : undefined,
|
|
};
|
|
}
|
|
}
|
|
|
|
const flagsRaw = reportData.totals_by_flag ?? reportData.components ?? [];
|
|
|
|
const coverage = toNumber(totals.coverage);
|
|
const baseCoverage = toNumber(compareTotals?.base_coverage ?? compareTotals?.base);
|
|
let delta = toNumber(
|
|
compareTotals?.coverage_change ??
|
|
compareTotals?.coverage_diff ??
|
|
totals.delta ??
|
|
totals.diff ??
|
|
totals.change,
|
|
);
|
|
|
|
if (delta === undefined && coverage !== undefined && baseCoverage !== undefined) {
|
|
delta = coverage - baseCoverage;
|
|
}
|
|
|
|
const formatPercent = (value) => {
|
|
if (value === undefined) return '—';
|
|
return `${value.toFixed(2)}%`;
|
|
};
|
|
|
|
const formatDelta = (value) => {
|
|
if (value === undefined) return '—';
|
|
const sign = value >= 0 ? '+' : '';
|
|
return `${sign}${value.toFixed(2)}%`;
|
|
};
|
|
|
|
const shortSha = commitSha.slice(0, 7);
|
|
const lines = [
|
|
'<!-- codecov-coverage-comment -->',
|
|
'**Codecov Coverage**',
|
|
'',
|
|
`- Head \`${shortSha}\`: ${formatPercent(coverage)}`,
|
|
];
|
|
|
|
if (baseCoverage !== undefined) {
|
|
lines.push(`- Base: ${formatPercent(baseCoverage)}`);
|
|
}
|
|
|
|
if (delta !== undefined) {
|
|
lines.push(`- Change: ${formatDelta(delta)}`);
|
|
}
|
|
|
|
const flagEntries = Array.isArray(flagsRaw)
|
|
? flagsRaw
|
|
: Object.entries(flagsRaw).map(([name, totals]) => ({ name, totals }));
|
|
|
|
const flagRows = [];
|
|
for (const entry of flagEntries) {
|
|
const label = entry.flag ?? entry.name ?? entry.component ?? entry.id;
|
|
const entryTotals = entry.totals ?? entry;
|
|
const entryCoverage = toNumber(entryTotals?.coverage);
|
|
const entryDelta = toNumber(
|
|
entryTotals?.coverage_change ??
|
|
entryTotals?.coverage_diff ??
|
|
entryTotals?.delta ??
|
|
entryTotals?.diff,
|
|
);
|
|
if (!label || entryCoverage === undefined) {
|
|
continue;
|
|
}
|
|
flagRows.push(`| ${label} | ${formatPercent(entryCoverage)} | ${formatDelta(entryDelta)} |`);
|
|
}
|
|
|
|
if (flagRows.length) {
|
|
lines.push('');
|
|
lines.push('| Flag | Coverage | Change |');
|
|
lines.push('| --- | --- | --- |');
|
|
lines.push(...flagRows);
|
|
}
|
|
|
|
const commentBody = lines.join('\n');
|
|
const shouldComment = coverage !== undefined;
|
|
core.setOutput('shouldComment', shouldComment ? 'true' : 'false');
|
|
if (shouldComment) {
|
|
core.setOutput('commentBody', commentBody);
|
|
}
|
|
- name: Upsert coverage comment
|
|
if: steps.pr.outputs.shouldRun == 'true' && steps.coverage.outputs.shouldComment == 'true'
|
|
uses: actions/github-script@v7
|
|
env:
|
|
PR_NUMBER: ${{ steps.pr.outputs.prNumber }}
|
|
COMMENT_BODY: ${{ steps.coverage.outputs.commentBody }}
|
|
with:
|
|
script: |
|
|
const prNumber = Number(process.env.PR_NUMBER);
|
|
const body = process.env.COMMENT_BODY;
|
|
const marker = '<!-- codecov-coverage-comment -->';
|
|
|
|
const { data: comments } = await github.rest.issues.listComments({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: prNumber,
|
|
per_page: 100,
|
|
});
|
|
|
|
const existing = comments.find((comment) => comment.body?.includes(marker));
|
|
if (existing) {
|
|
core.info(`Updating existing coverage comment (id: ${existing.id}).`);
|
|
await github.rest.issues.updateComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
comment_id: existing.id,
|
|
body,
|
|
});
|
|
} else {
|
|
core.info('Creating new coverage comment.');
|
|
await github.rest.issues.createComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: prNumber,
|
|
body,
|
|
});
|
|
}
|
|
frontend-bundle-analysis:
|
|
name: "Frontend Bundle Analysis"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- tests-frontend
|
|
- tests-frontend-e2e
|
|
steps:
|
|
- uses: actions/checkout@v5
|
|
- name: Install pnpm
|
|
uses: pnpm/action-setup@v4
|
|
with:
|
|
version: 10
|
|
- name: Use Node.js 20
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 20.x
|
|
cache: 'pnpm'
|
|
cache-dependency-path: 'src-ui/pnpm-lock.yaml'
|
|
- name: Cache frontend dependencies
|
|
id: cache-frontend-deps
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.pnpm-store
|
|
~/.cache
|
|
key: ${{ runner.os }}-frontenddeps-${{ hashFiles('src-ui/package-lock.json') }}
|
|
- name: Re-link Angular cli
|
|
run: cd src-ui && pnpm link @angular/cli
|
|
- name: Build frontend and upload analysis
|
|
env:
|
|
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
|
|
run: cd src-ui && pnpm run build --configuration=production
|
|
build-docker-image:
|
|
name: Build Docker image for ${{ github.ref_name }}
|
|
runs-on: ubuntu-24.04
|
|
if: github.event_name == 'push' && (startsWith(github.ref, 'refs/heads/feature-') || startsWith(github.ref, 'refs/heads/fix-') || github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/beta' || contains(github.ref, 'beta.rc') || startsWith(github.ref, 'refs/tags/v') || startsWith(github.ref, 'refs/heads/l10n_'))
|
|
concurrency:
|
|
group: ${{ github.workflow }}-build-docker-image-${{ github.ref_name }}
|
|
cancel-in-progress: true
|
|
needs:
|
|
- tests-backend
|
|
- tests-frontend
|
|
- tests-frontend-e2e
|
|
steps:
|
|
- name: Check pushing to Docker Hub
|
|
id: push-other-places
|
|
# Only push to Dockerhub from the main repo AND the ref is either:
|
|
# main
|
|
# dev
|
|
# beta
|
|
# a tag
|
|
# Otherwise forks would require a Docker Hub account and secrets setup
|
|
run: |
|
|
if [[ ${{ github.repository_owner }} == "paperless-ngx" && ( ${{ github.ref_name }} == "dev" || ${{ github.ref_name }} == "beta" || ${{ startsWith(github.ref, 'refs/tags/v') }} == "true" ) ]] ; then
|
|
echo "Enabling DockerHub image push"
|
|
echo "enable=true" >> $GITHUB_OUTPUT
|
|
else
|
|
echo "Not pushing to DockerHub"
|
|
echo "enable=false" >> $GITHUB_OUTPUT
|
|
fi
|
|
- name: Set ghcr repository name
|
|
id: set-ghcr-repository
|
|
run: |
|
|
ghcr_name=$(echo "${{ github.repository }}" | awk '{ print tolower($0) }')
|
|
echo "Name is ${ghcr_name}"
|
|
echo "ghcr-repository=${ghcr_name}" >> $GITHUB_OUTPUT
|
|
- name: Gather Docker metadata
|
|
id: docker-meta
|
|
uses: docker/metadata-action@v5
|
|
with:
|
|
images: |
|
|
ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}
|
|
name=paperlessngx/paperless-ngx,enable=${{ steps.push-other-places.outputs.enable }}
|
|
name=quay.io/paperlessngx/paperless-ngx,enable=${{ steps.push-other-places.outputs.enable }}
|
|
tags: |
|
|
# Tag branches with branch name
|
|
type=ref,event=branch
|
|
# Process semver tags
|
|
# For a tag x.y.z or vX.Y.Z, output an x.y.z and x.y image tag
|
|
type=semver,pattern={{version}}
|
|
type=semver,pattern={{major}}.{{minor}}
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
# If https://github.com/docker/buildx/issues/1044 is resolved,
|
|
# the append input with a native arm64 arch could be used to
|
|
# significantly speed up building
|
|
- name: Set up Docker Buildx
|
|
uses: docker/setup-buildx-action@v3
|
|
- name: Set up QEMU
|
|
uses: docker/setup-qemu-action@v3
|
|
with:
|
|
platforms: arm64
|
|
- name: Login to GitHub Container Registry
|
|
uses: docker/login-action@v3
|
|
with:
|
|
registry: ghcr.io
|
|
username: ${{ github.actor }}
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
- name: Login to Docker Hub
|
|
uses: docker/login-action@v3
|
|
# Don't attempt to login if not pushing to Docker Hub
|
|
if: steps.push-other-places.outputs.enable == 'true'
|
|
with:
|
|
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
|
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
|
- name: Login to Quay.io
|
|
uses: docker/login-action@v3
|
|
# Don't attempt to login if not pushing to Quay.io
|
|
if: steps.push-other-places.outputs.enable == 'true'
|
|
with:
|
|
registry: quay.io
|
|
username: ${{ secrets.QUAY_USERNAME }}
|
|
password: ${{ secrets.QUAY_ROBOT_TOKEN }}
|
|
- name: Build and push
|
|
uses: docker/build-push-action@v6
|
|
with:
|
|
context: .
|
|
file: ./Dockerfile
|
|
platforms: linux/amd64,linux/arm64
|
|
push: ${{ github.event_name != 'pull_request' }}
|
|
tags: ${{ steps.docker-meta.outputs.tags }}
|
|
labels: ${{ steps.docker-meta.outputs.labels }}
|
|
build-args: |
|
|
PNGX_TAG_VERSION=${{ steps.docker-meta.outputs.version }}
|
|
# Get cache layers from this branch, then dev
|
|
# This allows new branches to get at least some cache benefits, generally from dev
|
|
cache-from: |
|
|
type=registry,ref=ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}/builder/cache/app:${{ github.ref_name }}
|
|
type=registry,ref=ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}/builder/cache/app:dev
|
|
cache-to: |
|
|
type=registry,mode=max,ref=ghcr.io/${{ steps.set-ghcr-repository.outputs.ghcr-repository }}/builder/cache/app:${{ github.ref_name }}
|
|
- name: Inspect image
|
|
run: |
|
|
docker buildx imagetools inspect ${{ fromJSON(steps.docker-meta.outputs.json).tags[0] }}
|
|
- name: Export frontend artifact from docker
|
|
run: |
|
|
docker create --name frontend-extract ${{ fromJSON(steps.docker-meta.outputs.json).tags[0] }}
|
|
docker cp frontend-extract:/usr/src/paperless/src/documents/static/frontend src/documents/static/frontend/
|
|
- name: Upload frontend artifact
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: frontend-compiled
|
|
path: src/documents/static/frontend/
|
|
retention-days: 7
|
|
build-release:
|
|
name: "Build Release"
|
|
needs:
|
|
- build-docker-image
|
|
- documentation
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
- name: Set up Python
|
|
id: setup-python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v6
|
|
with:
|
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
|
enable-cache: true
|
|
python-version: ${{ steps.setup-python.outputs.python-version }}
|
|
- name: Install Python dependencies
|
|
run: |
|
|
uv sync --python ${{ steps.setup-python.outputs.python-version }} --dev --frozen
|
|
- name: Install system dependencies
|
|
run: |
|
|
sudo apt-get update -qq
|
|
sudo apt-get install -qq --no-install-recommends gettext liblept5
|
|
- name: Download frontend artifact
|
|
uses: actions/download-artifact@v5
|
|
with:
|
|
name: frontend-compiled
|
|
path: src/documents/static/frontend/
|
|
- name: Download documentation artifact
|
|
uses: actions/download-artifact@v5
|
|
with:
|
|
name: documentation
|
|
path: docs/_build/html/
|
|
- name: Generate requirements file
|
|
run: |
|
|
uv export --quiet --no-dev --all-extras --format requirements-txt --output-file requirements.txt
|
|
- name: Compile messages
|
|
run: |
|
|
cd src/
|
|
uv run \
|
|
--python ${{ steps.setup-python.outputs.python-version }} \
|
|
manage.py compilemessages
|
|
- name: Collect static files
|
|
run: |
|
|
cd src/
|
|
uv run \
|
|
--python ${{ steps.setup-python.outputs.python-version }} \
|
|
manage.py collectstatic --no-input
|
|
- name: Move files
|
|
run: |
|
|
echo "Making dist folders"
|
|
for directory in dist \
|
|
dist/paperless-ngx \
|
|
dist/paperless-ngx/scripts;
|
|
do
|
|
mkdir --verbose --parents ${directory}
|
|
done
|
|
|
|
echo "Copying basic files"
|
|
for file_name in .dockerignore \
|
|
.env \
|
|
Dockerfile \
|
|
pyproject.toml \
|
|
uv.lock \
|
|
requirements.txt \
|
|
LICENSE \
|
|
README.md \
|
|
paperless.conf.example
|
|
do
|
|
cp --verbose ${file_name} dist/paperless-ngx/
|
|
done
|
|
mv --verbose dist/paperless-ngx/paperless.conf.example dist/paperless-ngx/paperless.conf
|
|
|
|
echo "Copying Docker related files"
|
|
cp --recursive docker/ dist/paperless-ngx/docker
|
|
|
|
echo "Copying startup scripts"
|
|
cp --verbose scripts/*.service scripts/*.sh scripts/*.socket dist/paperless-ngx/scripts/
|
|
|
|
echo "Copying source files"
|
|
cp --recursive src/ dist/paperless-ngx/src
|
|
echo "Copying documentation"
|
|
cp --recursive docs/_build/html/ dist/paperless-ngx/docs
|
|
|
|
mv --verbose static dist/paperless-ngx
|
|
- name: Make release package
|
|
run: |
|
|
echo "Creating release archive"
|
|
cd dist
|
|
sudo chown -R 1000:1000 paperless-ngx/
|
|
tar -cJf paperless-ngx.tar.xz paperless-ngx/
|
|
- name: Upload release artifact
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: release
|
|
path: dist/paperless-ngx.tar.xz
|
|
retention-days: 7
|
|
publish-release:
|
|
name: "Publish Release"
|
|
runs-on: ubuntu-24.04
|
|
outputs:
|
|
prerelease: ${{ steps.get_version.outputs.prerelease }}
|
|
changelog: ${{ steps.create-release.outputs.body }}
|
|
version: ${{ steps.get_version.outputs.version }}
|
|
needs:
|
|
- build-release
|
|
if: github.ref_type == 'tag' && (startsWith(github.ref_name, 'v') || contains(github.ref_name, '-beta.rc'))
|
|
steps:
|
|
- name: Download release artifact
|
|
uses: actions/download-artifact@v5
|
|
with:
|
|
name: release
|
|
path: ./
|
|
- name: Get version
|
|
id: get_version
|
|
run: |
|
|
echo "version=${{ github.ref_name }}" >> $GITHUB_OUTPUT
|
|
if [[ ${{ contains(github.ref_name, '-beta.rc') }} == 'true' ]]; then
|
|
echo "prerelease=true" >> $GITHUB_OUTPUT
|
|
else
|
|
echo "prerelease=false" >> $GITHUB_OUTPUT
|
|
fi
|
|
- name: Create Release and Changelog
|
|
id: create-release
|
|
uses: release-drafter/release-drafter@v6
|
|
with:
|
|
name: Paperless-ngx ${{ steps.get_version.outputs.version }}
|
|
tag: ${{ steps.get_version.outputs.version }}
|
|
version: ${{ steps.get_version.outputs.version }}
|
|
prerelease: ${{ steps.get_version.outputs.prerelease }}
|
|
publish: true # ensures release is not marked as draft
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
- name: Upload release archive
|
|
id: upload-release-asset
|
|
uses: shogo82148/actions-upload-release-asset@v1
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
upload_url: ${{ steps.create-release.outputs.upload_url }}
|
|
asset_path: ./paperless-ngx.tar.xz
|
|
asset_name: paperless-ngx-${{ steps.get_version.outputs.version }}.tar.xz
|
|
asset_content_type: application/x-xz
|
|
append-changelog:
|
|
name: "Append Changelog"
|
|
runs-on: ubuntu-24.04
|
|
needs:
|
|
- publish-release
|
|
if: needs.publish-release.outputs.prerelease == 'false'
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
with:
|
|
ref: main
|
|
- name: Set up Python
|
|
id: setup-python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
|
- name: Install uv
|
|
uses: astral-sh/setup-uv@v6
|
|
with:
|
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
|
enable-cache: true
|
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
|
- name: Append Changelog to docs
|
|
id: append-Changelog
|
|
working-directory: docs
|
|
run: |
|
|
git branch ${{ needs.publish-release.outputs.version }}-changelog
|
|
git checkout ${{ needs.publish-release.outputs.version }}-changelog
|
|
echo -e "# Changelog\n\n${{ needs.publish-release.outputs.changelog }}\n" > changelog-new.md
|
|
echo "Manually linking usernames"
|
|
sed -i -r 's|@([a-zA-Z0-9_]+) \(\[#|[@\1](https://github.com/\1) ([#|g' changelog-new.md
|
|
echo "Removing unneeded comment tags"
|
|
sed -i -r 's|@<!---->|@|g' changelog-new.md
|
|
CURRENT_CHANGELOG=`tail --lines +2 changelog.md`
|
|
echo -e "$CURRENT_CHANGELOG" >> changelog-new.md
|
|
mv changelog-new.md changelog.md
|
|
uv run \
|
|
--python ${{ steps.setup-python.outputs.python-version }} \
|
|
--dev \
|
|
pre-commit run --files changelog.md || true
|
|
git config --global user.name "github-actions"
|
|
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
git commit -am "Changelog ${{ needs.publish-release.outputs.version }} - GHA"
|
|
git push origin ${{ needs.publish-release.outputs.version }}-changelog
|
|
- name: Create Pull Request
|
|
uses: actions/github-script@v7
|
|
with:
|
|
script: |
|
|
const { repo, owner } = context.repo;
|
|
const result = await github.rest.pulls.create({
|
|
title: 'Documentation: Add ${{ needs.publish-release.outputs.version }} changelog',
|
|
owner,
|
|
repo,
|
|
head: '${{ needs.publish-release.outputs.version }}-changelog',
|
|
base: 'main',
|
|
body: 'This PR is auto-generated by CI.'
|
|
});
|
|
github.rest.issues.addLabels({
|
|
owner,
|
|
repo,
|
|
issue_number: result.data.number,
|
|
labels: ['documentation', 'skip-changelog']
|
|
});
|