diff --git a/packages/artifact/docs/faq.md b/packages/artifact/docs/faq.md index c88d5c11..b589bef2 100644 --- a/packages/artifact/docs/faq.md +++ b/packages/artifact/docs/faq.md @@ -33,3 +33,24 @@ The value can range from 0 to 9: Higher levels will result in better compression, but will take longer to complete. 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? +[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. + +1. **Matching Versions:** + - Use matching versions of `actions/upload-artifact` and `actions/download-artifact` to ensure compatibility. + +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 + uses: actions/upload-artifact@v4 + # ... + uses: actions/download-artifact@v4 + # ... + ``` + +3. **Release Notes:** + - 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? +The default retention period is 90 days. For more information, visit: https://github.com/actions/upload-artifact?tab=readme-ov-file#retention-period