How To Upload Existing Repository To Github
Upload-Artifact v3
This uploads artifacts from your workflow allowing you to share data between jobs and store data once a workflow is consummate.
See as well download-artifact.
What's new
- Easier upload
- Specify a wildcard pattern
- Specify an individual file
- Specify a directory (previously you were limited to only this option)
- Multi path upload
- Employ a combination of private files, wildcards or directories
- Back up for excluding certain files
- Upload an antiquity without providing a name
- Fix for artifact uploads sometimes not working with containers
- Proxy back up out of the box
- Port entire action to typescript from a runner plugin so it is easier to collaborate and accept contributions
Refer here for the previous version
Usage
Run across action.yml
Upload an Individual File
steps: - uses: deportment/checkout@v2 - run: mkdir -p path/to/artifact - run: repeat hello > path/to/antiquity/world.txt - uses: actions/upload-artifact@v3 with: name: my-artifact path: path/to/artifact/world.txt Upload an Entire Directory
- uses: actions/upload-antiquity@v3 with: name: my-artifact path: path/to/artifact/ # or path/to/artifact Upload using a Wildcard Blueprint
- uses: actions/upload-artifact@v3 with: proper noun: my-artifact path: path/**/[abc]rtifac?/* Upload using Multiple Paths and Exclusions
- uses: deportment/upload-antiquity@v3 with: proper noun: my-antiquity path: | path/output/bin/ path/output/test-results !path/**/*.tmp For supported wildcards forth with beliefs and documentation, run into @deportment/glob which is used internally to search for files.
If a wildcard pattern is used, the path hierarchy will exist preserved later the first wildcard pattern:
path/to/*/directory/foo?.txt => ∟ path/to/some/directory/foo1.txt ∟ path/to/some/directory/foo2.txt ∟ path/to/other/directory/foo1.txt would exist flattened and uploaded as => ∟ some/directory/foo1.txt ∟ some/directory/foo2.txt ∟ other/directory/foo1.txt If multiple paths are provided equally input, the least common ancestor of all the search paths will exist used as the root directory of the artifact. Exclude paths do non affect the directory construction.
Relative and absolute file paths are both allowed. Relative paths are rooted against the current working directory. Paths that begin with a wildcard character should be quoted to avert being interpreted as YAML aliases.
The @deportment/artifact package is used internally to handle most of the logic around uploading an antiquity. There is extra documentation effectually upload limitations and beliefs in the toolkit repo that is worth checking out.
Customization if no files are institute
If a path (or paths), result in no files being establish for the antiquity, the action will succeed simply print out a warning. In certain scenarios it may be desirable to fail the action or suppress the warning. The if-no-files-found pick allows you to customize the behavior of the action if no files are plant:
- uses: actions/upload-artifact@v3 with: proper name: my-artifact path: path/to/artifact/ if-no-files-establish: error # 'warn' or 'ignore' are besides available, defaults to `warn` Provisional Antiquity Upload
To upload artifacts only when the previous stride of a job failed, apply if: failure():
- uses: actions/upload-artifact@v3 if: failure() with: name: my-artifact path: path/to/artifact/ Uploading without an artifact name
You can upload an artifact without specifying a name
- uses: deportment/upload-artifact@v3 with: path: path/to/artifact/world.txt If not provided, artifact will exist used equally the default name which will manifest itself in the UI after upload.
Uploading to the same artifact
With the following example, the bachelor antiquity (named artifact by default if no name is provided) would contain both world.txt (hello) and extra-file.txt (howdy):
- run: repeat hi > world.txt - uses: actions/upload-artifact@v3 with: path: world.txt - run: repeat howdy > extra-file.txt - uses: actions/upload-artifact@v3 with: path: extra-file.txt - run: echo hullo > world.txt - uses: actions/upload-artifact@v3 with: path: globe.txt Each artifact behaves equally a file share. Uploading to the same artifact multiple times in the same workflow tin can overwrite and append already uploaded files:
strategy: matrix: node-version: [8.x, ten.10, 12.x, 13.x] steps: - proper name: Create a file run: echo ${{ matrix.node-version }} > my_file.txt - name: Accidentally upload to the same antiquity via multiple jobs uses: actions/upload-artifact@v3 with: name: my-artifact path: ${{ github.workspace }} Warning: Be careful when uploading to the same artifact via multiple jobs as artifacts may become corrupted. When uploading a file with an identical proper noun and path in multiple jobs, uploads may fail with 503 errors due to conflicting uploads happening at the same time. Ensure uploads to identical locations to not interfere with each other.
In the above example, four jobs volition upload four dissimilar files to the same artifact simply in that location will only be one file available when my-antiquity is downloaded. Each task overwrites what was previously uploaded. To ensure that jobs don't overwrite existing artifacts, employ a different proper name per job:
uses: actions/upload-artifact@v3 with: name: my-artifact ${{ matrix.node-version }} path: ${{ github.workspace }} Surround Variables and Tilde Expansion
You lot can utilize ~ in the path input as a substitute for $Habitation. Basic tilde expansion is supported:
- run: | mkdir -p ~/new/artifact echo how-do-you-do > ~/new/artifact/globe.txt - uses: deportment/upload-artifact@v3 with: name: Artifacts-V3 path: ~/new/**/* Environment variables along with context expressions tin can too exist used for input. For documentation run into context and expression syntax:
env: name: my-artifact steps: - run: | mkdir -p ${{ github.workspace }}/antiquity echo hello > ${{ github.workspace }}/artifact/world.txt - uses: actions/upload-artifact@v3 with: proper name: ${{ env.name }}-name path: ${{ github.workspace }}/antiquity/**/* For environment variables created in other steps, make sure to employ the env expression syntax
steps: - run: | mkdir testing echo "This is a file to upload" > testing/file.txt echo "artifactPath=testing/file.txt" >> $GITHUB_ENV - uses: actions/upload-artifact@v3 with: name: artifact path: ${{ env.artifactPath }} # this volition resolve to testing/file.txt at runtime Memory Period
Artifacts are retained for 90 days by default. You tin specify a shorter retention catamenia using the retentiveness-days input:
- proper noun: Create a file run: echo "I won't live long" > my_file.txt - name: Upload Artifact uses: actions/upload-antiquity@v3 with: proper name: my-artifact path: my_file.txt retentiveness-days: 5 The retention catamenia must be between one and 90 inclusive. For more data see artifact and log retentiveness policies.
Where does the upload become?
At the bottom of the workflow summary page, in that location is a dedicated department for artifacts. Here's a screenshot of something you might run across:
At that place is a trashcan icon that can be used to delete the artifact. This icon volition only appear for users who have write permissions to the repository.
The size of the artifact is denoted in bytes. The displayed antiquity size denotes the raw uploaded antiquity size (the sum of all the individual files uploaded during the workflow run for the artifact), non the compressed size. When you click to download an artifact from the summary page, a compressed zip is created with all the contents of the artifact and the size of the nix that you lot download may differ significantly from the displayed size. Billing is based on the raw uploaded size and not the size of the zip.
Limitations
Zipped Artifact Downloads
During a workflow run, files are uploaded and downloaded individually using the upload-artifact and download-artifact deportment. However, when a workflow run finishes and an antiquity is downloaded from either the UI or through the download api, a zip is dynamically created with all the file contents that were uploaded. There is currently no mode to download artifacts after a workflow run finishes in a format other than a nada or to download artifact contents individually. One of the consequences of this limitation is that if a zip is uploaded during a workflow run and then downloaded from the UI, in that location will exist a double nil created.
Permission Loss
chmod and so upload that file, post-download the file is no longer guaranteed to be set as an executable.
Case Insensitive Uploads
A.txt and a.txt with the aforementioned root path, only a single file volition exist saved and available during download.
Maintaining file permissions and case sensitive files
If file permissions and instance sensitivity are required, you lot tin tar all of your files together before artifact upload. Post download, the tar file volition maintain file permissions and case sensitivity:
- name: Tar files run: tar -cvf my_files.tar /path/to/my/directory - name: Upload Antiquity uses: actions/upload-artifact@v3 with: proper noun: my-antiquity path: my_files.tar As well many uploads resulting in 429 responses
A very minute subset of users who upload a very very large amount of artifacts in a brusk flow of fourth dimension may encounter their uploads throttled or neglect because of Request was blocked due to exceeding usage of resources 'DBCPU' in namespace or Unable to copy file to server StatusCode=TooManyRequests.
To reduce the chance of this happening, you can reduce the number of HTTP calls made during artifact upload by zipping or archiving the contents of your artifact earlier an upload starts. Every bit an example, imagine an artifact with chiliad files (each ten Kb in size). Without any modification, at that place would be effectually 1000 HTTP calls made to upload the antiquity. If you nothing or annal the artifact beforehand, the number of HTTP calls can be dropped to single digit territory. Measures like this volition significantly speed upward your upload and prevent uploads from existence throttled or in some cases fail.
Additional Documentation
Come across Storing workflow data every bit artifacts for boosted examples and tips.
See actress documentation for the @deportment/artifact parcel that is used internally regarding certain behaviors and limitations.
License
The scripts and documentation in this projection are released nether the MIT License.
Source: https://github.com/actions/upload-artifact
Posted by: hobbssouthe1959.blogspot.com
0 Response to "How To Upload Existing Repository To Github"
Post a Comment