Skip to content

docs: new features from 0.30.0 #2077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mistydemeo merged 3 commits into from
Sep 7, 2025
Merged

docs: new features from 0.30.0 #2077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
35cfe48
docs: extra environment variables
mistydemeo Sep 6, 2025
4bebedf
docs: attestation docs tweaks
mistydemeo Sep 6, 2025
abb679e
docs: proxy variables
mistydemeo Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions book/src/installers/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,10 @@ requested API structure expectations to match either:
- Public artifact URLs: https://{CUSTOM}/owner/repo/releases/download/version/artifact-name
- Releases API: https://{CUSTOM}/api/v3/repos/owner/repo/releases/latest ([docs](https://docs.github.com/en/enterprise-server@3.14/rest/releases/releases?apiVersion=2022-11-28))

Users can also override the entire URL for the artifact by specifying `${app name}_DOWNLOAD_URL` (available since 0.30.0).

`dist` is eager to support enterprise level features like this- so if you have questions
or related feature requests, please join our [Discord](https://discord.gg/MnyjrpTceV) or send
us an email at hello@axo.dev.
or related feature requests, please join our [Discord](https://discord.gg/MnyjrpTceV).

## GitHub bearer token

Expand All @@ -127,6 +128,23 @@ By default, the installer fetches archives without using any form of authenticat

- `${app name}_GITHUB_TOKEN`

## Proxy

> since 0.1.0 (shell), 0.30.0 (powershell)

Users who need to fetch artifacts via a proxy can set the `HTTPS_PROXY` or `ALL_PROXY` environment variables. This is compatible with the syntax used by cURL; for more information, see [cURL's documentation](https://everything.curl.dev/usingcurl/proxies/env.html).

## Verbosity

> since 0.30.0

Users can customize the verbosity of the shell installer by specifying one of two environment variables:

- `${app name}_PRINT_QUIET` (also available as `--quiet` on the commandline)
- `${app name}_PRINT_VERBOSE` (also available as `--verbose` on the commandline)

`${app name}_PRINT_QUIET` will suppress warnings and error messages, while `${app name}_PRINT_VERBOSE` will print some extra debugging messages.

## Receipt

> since 0.9.0
Expand Down
6 changes: 5 additions & 1 deletion book/src/reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1086,6 +1086,8 @@ If you're using GitHub Releases, this will enable GitHub's experimental artifact
> github-attestations-phase = "host"
> ```

Most users won't need to use this feature. If you've enabled `github-attestations`, attestations are ordinarily performed while local builds are running. Users making use of the [`build-local-artifacts = false`](#build-local-artifacts) setting to perform their own builds won't be able to make use of attestations in that phase, so these users will need to move attestations to another phase.

Possible values:

* `host`: Create the GitHub Attestations during the `host` phase.
Expand All @@ -1105,7 +1107,9 @@ Possible values:
> github-attestations-filters = ["*.json", "*.sh", "*.ps1", "*.zip", "*.tar.gz"]
> ```

Allows filtering GitHub Attestations in the `host` phase. All patterns are globed against the pattern `artifacts/{filter}`.
Allows configuring which artifacts to perform GitHub Attestations for in the `host` phase. All patterns are globed against the pattern `artifacts/{filter}`.

This doesn't currently support attestations performed in the `build-local-artifacts` phase, but support for this may be added in the future.

#### `github-release`

Expand Down
5 changes: 1 addition & 4 deletions book/src/supplychain-security/attestations/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ Note that GitHub's Artifact Attestations only supports public repositories and p

Currently, verification of GitHub Artifact Attestations is only supported via GitHub CLI with [`gh attestation verify`].

Additionally, you can control which phase attestations occur using the [`github-attestations-phase` setting](../../reference/config.md#github-attestations-phase).

By default, attestations occur during the `build-local-artifacts` phase. This can be alternatively be changed to the `host` phase, which is particularly
useful when `build-local-artifacts` is set to `false`.
The phase in which attestations occur can be configured using the [`github-attestations-phase` setting](../../reference/config.md#github-attestations-phase). By default, attestations occur during the `build-local-artifacts` phase. This can be be changed to the `host` phase, which is particularly useful when `build-local-artifacts` is set to `false`.

When performing attestations in the `host` phase, you can control what gets attested by using the [`github-attestations-filters` setting](../../reference/config.md#github-attestations-filters).

Expand Down
Loading