actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

Merge pull request #1627 from actions/eggyhead/hyperlinks-faq 

adding hyperlinks for new section of artifacts faq
pull/1464/head^2
eggyhead 2024-01-19 08:40:40 -08:00 committed by GitHub
parent 4e3b068ce1 74bca717aa
commit 1fe633e27c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
packages/artifact/docs/faq.md
View File

@ -3,6 +3,8 @@
- [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
@ -35,13 +37,17 @@ 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), 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. [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.
1. **Matching Versions:** | upload-artifact | download-artifact | toolkit |
- 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
# ... # ...
@ -49,8 +55,8 @@ For large files that are not easily compressed, a value of 0 is recommended for
# ... # ...
``` ```
3. **Release Notes:** **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