Compare commits

..
2 changed files with 20 additions and 22 deletions
+8 -14
View File
@@ -3,8 +3,6 @@
- [Frequently Asked Questions](#frequently-asked-questions) - [Frequently Asked Questions](#frequently-asked-questions)
- [Supported Characters](#supported-characters) - [Supported Characters](#supported-characters)
- [Compression? ZIP? How is my artifact stored?](#compression-zip-how-is-my-artifact-stored) - [Compression? ZIP? How is my artifact stored?](#compression-zip-how-is-my-artifact-stored)
- [Which versions of the artifacts packages are compatible?](#which-versions-of-the-artifacts-packages-are-compatible)
- [How long will my artifact be available?](#how-long-will-my-artifact-be-available)
## Supported Characters ## Supported Characters
@@ -37,17 +35,13 @@ Higher levels will result in better compression, but will take longer to complet
For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads. For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
## Which versions of the artifacts packages are compatible? ## Which versions of the artifacts packages are compatible?
[actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/download-artifact](https://github.com/actions/download-artifact), leverage [GitHub Actions toolkit](https://github.com/actions/toolkit) and are typically used together to upload and download artifacts in your workflows. [actions/upload-artifact](https://github.com/actions/upload-artifact) and [actions/download-artifact](https://github.com/actions/download-artifact), are part of the [GitHub Actions toolkit](https://github.com/actions/toolkit) and are typically used together to upload and download artifacts in your workflows.
| upload-artifact | download-artifact | toolkit | 1. **Matching Versions:**
|---|---|---| - Use matching versions of `actions/upload-artifact` and `actions/download-artifact` to ensure compatibility.
| v4 | v4 | v2 |
| < v3 | < v3 | < v1 |
Use matching versions of `actions/upload-artifact` and `actions/download-artifact` to ensure compatibility.
In your GitHub Actions workflow YAML file, you specify the version of the actions you want to use. For example:
2. **Workflow YAML File:**
- In your GitHub Actions workflow YAML file, you specify the version of the actions you want to use. For example:
```yaml ```yaml
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4
# ... # ...
@@ -55,8 +49,8 @@ In your GitHub Actions workflow YAML file, you specify the version of the action
# ... # ...
``` ```
**Release Notes:** 3. **Release Notes:**
Check the release notes for each repository to see if there are any specific notes about compatibility or changes in behavior. - Check the release notes for each repository to see if there are any specific notes about compatibility or changes in behavior.
## How long will my artifact be available? ## How long will my artifact be available?
The default retention period is **90 days**. For more information, visit: https://github.com/actions/upload-artifact?tab=readme-ov-file#retention-period The default retention period is 90 days. For more information, visit: https://github.com/actions/upload-artifact?tab=readme-ov-file#retention-period
@@ -49,7 +49,9 @@ export async function getArtifactPublic(
if (getArtifactResp.data.artifacts.length === 0) { if (getArtifactResp.data.artifacts.length === 0) {
throw new ArtifactNotFoundError( throw new ArtifactNotFoundError(
`Artifact not found for name: ${artifactName}` `Artifact not found for name: ${artifactName}
Please ensure that your artifact is not expired and the artifact was uploaded using a compatible version of toolkit/upload-artifact.
For more information, visit the GitHub Artifacts FAQ: https://github.com/actions/toolkit/blob/main/packages/artifact/docs/faq.md`
) )
} }
@@ -89,7 +91,9 @@ export async function getArtifactInternal(
if (res.artifacts.length === 0) { if (res.artifacts.length === 0) {
throw new ArtifactNotFoundError( throw new ArtifactNotFoundError(
`Artifact not found for name: ${artifactName}` `Artifact not found for name: ${artifactName}
Please ensure that your artifact is not expired and the artifact was uploaded using a compatible version of toolkit/upload-artifact.
For more information, visit the GitHub Artifacts FAQ: https://github.com/actions/toolkit/blob/main/packages/artifact/docs/faq.md`
) )
} }