diff --git a/docs/administration/config-cheat-sheet.md b/docs/administration/config-cheat-sheet.md index a21a734e..34b9f5a3 100644 --- a/docs/administration/config-cheat-sheet.md +++ b/docs/administration/config-cheat-sheet.md @@ -1708,6 +1708,7 @@ PROXY_HOSTS = *.github.com - `ARTIFACT_RETENTION_DAYS`: **90**: Days to keep artifacts. Old artifacts will be deleted after this period. 0 means keep forever. Changes only apply to newly uploaded artifacts, existing ones keep the expiry stored when they were uploaded. Artifacts could have their own retention periods by setting the `retention-days` option in `actions/upload-artifact` step. +- `ARTIFACT_PREVIEW_MAX_SIZE`: **10485760**: Maximum total artifact size in bytes that can be browsed or previewed in the web UI. Set to `0` to disable artifact previews or `-1` for no limit. Individual files are also limited by [`MAX_DISPLAY_FILE_SIZE`](#ui-ui). - `RUN_RETENTION_DAYS`: **400**: Days to keep completed runs. Old runs and everything under them will be deleted after this period. 0 means keep forever. - `ZOMBIE_TASK_TIMEOUT`: **10m**: Timeout to stop the task which have running status, but haven't been updated for a long time - `ENDLESS_TASK_TIMEOUT`: **3h**: Timeout to stop the tasks which have running status and continuous updates, but don't end for a long time diff --git a/docs/usage/actions/artifacts.md b/docs/usage/actions/artifacts.md new file mode 100644 index 00000000..5b390b42 --- /dev/null +++ b/docs/usage/actions/artifacts.md @@ -0,0 +1,31 @@ +--- +date: "2026-08-30T00:00:00+02:00" +slug: "artifacts" +sidebar_position: 70 +--- + +# Artifacts + +Workflow runs can store files such as test results, coverage reports, and build output as artifacts. Artifacts are uploaded by workflows, for example with [`actions/upload-artifact`](https://github.com/actions/upload-artifact), and appear on the run page after the upload completes. + +## Previewing artifacts + +Select an artifact on the run page to open its file browser and preview in the same tab. The preview identifies the originating run and attempt, and provides links back to that run and to download the complete artifact. Selecting files in the browser updates the preview in the same tab. + +Artifact previews: + +- require sign-in and access to the Actions run to open the preview page +- render text-based files, images (including SVG), and PDFs +- run HTML and JavaScript content in a sandboxed frame + +Preview content is loaded through signed URLs that expire after one hour and do not require a session cookie. Reopen the preview page to obtain a fresh URL after it expires. + +The file browser lists up to 2,000 files per artifact. Larger artifacts show a notice when the list is truncated. + +Unsupported or oversized files can still be downloaded with the complete artifact. + +## Instance configuration + +Site administrators can limit the total artifact size that can be browsed or previewed with `ARTIFACT_PREVIEW_MAX_SIZE` in the `[actions]` section of `app.ini`. The default is 10 MiB. Set it to `0` to disable previews or `-1` to allow artifacts of any size. + +The size of an individual previewed file is also limited by [`MAX_DISPLAY_FILE_SIZE`](../../administration/config-cheat-sheet.md#ui-ui) in the `[ui]` section. diff --git a/versioned_docs/version-28/administration/config-cheat-sheet.md b/versioned_docs/version-28/administration/config-cheat-sheet.md index a21a734e..34b9f5a3 100644 --- a/versioned_docs/version-28/administration/config-cheat-sheet.md +++ b/versioned_docs/version-28/administration/config-cheat-sheet.md @@ -1708,6 +1708,7 @@ PROXY_HOSTS = *.github.com - `ARTIFACT_RETENTION_DAYS`: **90**: Days to keep artifacts. Old artifacts will be deleted after this period. 0 means keep forever. Changes only apply to newly uploaded artifacts, existing ones keep the expiry stored when they were uploaded. Artifacts could have their own retention periods by setting the `retention-days` option in `actions/upload-artifact` step. +- `ARTIFACT_PREVIEW_MAX_SIZE`: **10485760**: Maximum total artifact size in bytes that can be browsed or previewed in the web UI. Set to `0` to disable artifact previews or `-1` for no limit. Individual files are also limited by [`MAX_DISPLAY_FILE_SIZE`](#ui-ui). - `RUN_RETENTION_DAYS`: **400**: Days to keep completed runs. Old runs and everything under them will be deleted after this period. 0 means keep forever. - `ZOMBIE_TASK_TIMEOUT`: **10m**: Timeout to stop the task which have running status, but haven't been updated for a long time - `ENDLESS_TASK_TIMEOUT`: **3h**: Timeout to stop the tasks which have running status and continuous updates, but don't end for a long time diff --git a/versioned_docs/version-28/usage/actions/artifacts.md b/versioned_docs/version-28/usage/actions/artifacts.md new file mode 100644 index 00000000..5b390b42 --- /dev/null +++ b/versioned_docs/version-28/usage/actions/artifacts.md @@ -0,0 +1,31 @@ +--- +date: "2026-08-30T00:00:00+02:00" +slug: "artifacts" +sidebar_position: 70 +--- + +# Artifacts + +Workflow runs can store files such as test results, coverage reports, and build output as artifacts. Artifacts are uploaded by workflows, for example with [`actions/upload-artifact`](https://github.com/actions/upload-artifact), and appear on the run page after the upload completes. + +## Previewing artifacts + +Select an artifact on the run page to open its file browser and preview in the same tab. The preview identifies the originating run and attempt, and provides links back to that run and to download the complete artifact. Selecting files in the browser updates the preview in the same tab. + +Artifact previews: + +- require sign-in and access to the Actions run to open the preview page +- render text-based files, images (including SVG), and PDFs +- run HTML and JavaScript content in a sandboxed frame + +Preview content is loaded through signed URLs that expire after one hour and do not require a session cookie. Reopen the preview page to obtain a fresh URL after it expires. + +The file browser lists up to 2,000 files per artifact. Larger artifacts show a notice when the list is truncated. + +Unsupported or oversized files can still be downloaded with the complete artifact. + +## Instance configuration + +Site administrators can limit the total artifact size that can be browsed or previewed with `ARTIFACT_PREVIEW_MAX_SIZE` in the `[actions]` section of `app.ini`. The default is 10 MiB. Set it to `0` to disable previews or `-1` to allow artifacts of any size. + +The size of an individual previewed file is also limited by [`MAX_DISPLAY_FILE_SIZE`](../../administration/config-cheat-sheet.md#ui-ui) in the `[ui]` section.