mirror of
				https://github.com/actions/download-artifact.git
				synced 2025-10-31 16:43:41 +00:00 
			
		
		
		
	Update README for download-artifact v5 changes
Updated documentation for download-artifact action to reflect changes in version 5.
This commit is contained in:
		
							parent
							
								
									634f93cb29
								
							
						
					
					
						commit
						7d782037f3
					
				
							
								
								
									
										59
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										59
									
								
								README.md
									
									
									
									
									
								
							| @ -5,6 +5,7 @@ Download [Actions Artifacts](https://docs.github.com/en/actions/using-workflows/ | |||||||
| See also [upload-artifact](https://github.com/actions/upload-artifact). | See also [upload-artifact](https://github.com/actions/upload-artifact). | ||||||
| 
 | 
 | ||||||
| - [`@actions/download-artifact`](#actionsdownload-artifact) | - [`@actions/download-artifact`](#actionsdownload-artifact) | ||||||
|  |   - [v5 - What's new](#v5---whats-new) | ||||||
|   - [v4 - What's new](#v4---whats-new) |   - [v4 - What's new](#v4---whats-new) | ||||||
|     - [Improvements](#improvements) |     - [Improvements](#improvements) | ||||||
|     - [Breaking Changes](#breaking-changes) |     - [Breaking Changes](#breaking-changes) | ||||||
| @ -21,6 +22,42 @@ See also [upload-artifact](https://github.com/actions/upload-artifact). | |||||||
|   - [Limitations](#limitations) |   - [Limitations](#limitations) | ||||||
|     - [Permission Loss](#permission-loss) |     - [Permission Loss](#permission-loss) | ||||||
| 
 | 
 | ||||||
|  | ## v5 - What's new | ||||||
|  | 
 | ||||||
|  | Previously, **single artifact downloads** behaved differently depending on how you specified the artifact: | ||||||
|  | 
 | ||||||
|  | - **By name**: `name: my-artifact` → extracted to `path/` (direct) | ||||||
|  | - **By ID**: `artifact-ids: 12345` → extracted to `path/my-artifact/` (nested) | ||||||
|  | 
 | ||||||
|  | Now both methods are consistent: | ||||||
|  | 
 | ||||||
|  | - **By name**: `name: my-artifact` → extracted to `path/` (unchanged) | ||||||
|  | - **By ID**: `artifact-ids: 12345` → extracted to `path/` (updated - now direct) | ||||||
|  | 
 | ||||||
|  | #### Migration Guide | ||||||
|  | 
 | ||||||
|  | You download **single artifacts by ID** and your workflows expect the nested directory structure. | ||||||
|  | 
 | ||||||
|  | **Before v5 (nested structure):** | ||||||
|  | 
 | ||||||
|  | ```yaml | ||||||
|  | - uses: actions/download-artifact@v4 | ||||||
|  |   with: | ||||||
|  |     artifact-ids: 12345 | ||||||
|  |     path: dist | ||||||
|  | # Files were in: dist/my-artifact/ | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | > Where `my-artifact` is the name of the artifact you previously uploaded | ||||||
|  | 
 | ||||||
|  | **To maintain old behavior:** | ||||||
|  | 
 | ||||||
|  | ```yaml | ||||||
|  | - uses: actions/download-artifact@v5 | ||||||
|  |   with: | ||||||
|  |     artifact-ids: 12345 | ||||||
|  |     path: dist/my-artifact  # Explicitly specify the nested path | ||||||
|  | ``` | ||||||
| 
 | 
 | ||||||
| ## v4 - What's new | ## v4 - What's new | ||||||
| 
 | 
 | ||||||
| @ -66,7 +103,7 @@ You are welcome to still raise bugs in this repo. | |||||||
| ### Inputs | ### Inputs | ||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     # Name of the artifact to download. |     # Name of the artifact to download. | ||||||
|     # If unspecified, all artifacts for the run are downloaded. |     # If unspecified, all artifacts for the run are downloaded. | ||||||
| @ -124,7 +161,7 @@ Download to current working directory (`$GITHUB_WORKSPACE`): | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     name: my-artifact |     name: my-artifact | ||||||
| - name: Display structure of downloaded files | - name: Display structure of downloaded files | ||||||
| @ -135,7 +172,7 @@ Download to a specific directory (also supports `~` expansion): | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     name: my-artifact |     name: my-artifact | ||||||
|     path: your/destination/dir |     path: your/destination/dir | ||||||
| @ -151,7 +188,7 @@ Download a single artifact by ID to the current working directory (`$GITHUB_WORK | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     artifact-ids: 12345 |     artifact-ids: 12345 | ||||||
| - name: Display structure of downloaded files | - name: Display structure of downloaded files | ||||||
| @ -162,7 +199,7 @@ Download a single artifact by ID to a specific directory: | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     artifact-ids: 12345 |     artifact-ids: 12345 | ||||||
|     path: your/destination/dir |     path: your/destination/dir | ||||||
| @ -176,7 +213,7 @@ Multiple artifacts can be downloaded by providing a comma-separated list of IDs: | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     artifact-ids: 12345,67890 |     artifact-ids: 12345,67890 | ||||||
|     path: path/to/artifacts |     path: path/to/artifacts | ||||||
| @ -204,7 +241,7 @@ Download all artifacts to the current working directory: | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
| - name: Display structure of downloaded files | - name: Display structure of downloaded files | ||||||
|   run: ls -R |   run: ls -R | ||||||
| ``` | ``` | ||||||
| @ -213,7 +250,7 @@ Download all artifacts to a specific directory: | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     path: path/to/artifacts |     path: path/to/artifacts | ||||||
| - name: Display structure of downloaded files | - name: Display structure of downloaded files | ||||||
| @ -224,7 +261,7 @@ To download them to the _same_ directory: | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     path: path/to/artifacts |     path: path/to/artifacts | ||||||
|     merge-multiple: true |     merge-multiple: true | ||||||
| @ -264,7 +301,7 @@ jobs: | |||||||
|     runs-on: ubuntu-latest |     runs-on: ubuntu-latest | ||||||
|     steps: |     steps: | ||||||
|     - name: Download All Artifacts |     - name: Download All Artifacts | ||||||
|       uses: actions/download-artifact@v4 |       uses: actions/download-artifact@v5 | ||||||
|       with: |       with: | ||||||
|         path: my-artifact |         path: my-artifact | ||||||
|         pattern: my-artifact-* |         pattern: my-artifact-* | ||||||
| @ -287,7 +324,7 @@ It may be useful to download Artifacts from other workflow runs, or even other r | |||||||
| 
 | 
 | ||||||
| ```yaml | ```yaml | ||||||
| steps: | steps: | ||||||
| - uses: actions/download-artifact@v4 | - uses: actions/download-artifact@v5 | ||||||
|   with: |   with: | ||||||
|     name: my-other-artifact |     name: my-other-artifact | ||||||
|     github-token: ${{ secrets.GH_PAT }} # token with actions:read permissions on target repo |     github-token: ${{ secrets.GH_PAT }} # token with actions:read permissions on target repo | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user