https://github.com/cytopia/upload-artifact-verify-action
https://github.com/cytopia/upload-artifact-verify-action
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cytopia/upload-artifact-verify-action
- Owner: cytopia
- License: mit
- Created: 2022-03-25T20:11:47.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-05T03:12:06.000Z (almost 2 years ago)
- Last Synced: 2025-04-02T11:36:43.680Z (2 months ago)
- Size: 43 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Upload artifact verify action
[](https://github.com/cytopia/upload-artifact-verify-action/releases/latest)
[](https://github.com/marketplace/actions/upload-artifact-verify)
[](https://github.com/cytopia/upload-artifact-verify-action "github.com/cytopia/upload-artifact-verify-action")
[](https://github.com/cytopia/upload-artifact-verify-action/actions/workflows/test.yml)
This action allows you to upload an artifact. It will then download it in the background to ensure the upload was successful. You can additionally issue pre and post commands.
## :arrow_forward: Inputs
The following inputs can be used to alter the Docker tag name determination:
| Input | Required | Default | Description |
|----------------|----------|---------|-------------------------------------------|
| `name` | Yes | `` | The artifact name. |
| `path` | Yes | `` | The local file to upload. |
| `pre_command` | No | `` | A bash command to execute before uploading the artifact (e.g.: to create the artifact) |
| `post_command` | No | `` | A bash command to execute after downloading the artifact (e.g.: to verify it is the desired file)
The `{{download_path}}` placeholder is available to refer to the downloaded file. |
## :arrow_backward: Outputs
None
## :computer: Usage
### Simple
```yaml
on: [push]
jobs:
job1:
runs-on: ubuntu-latest
name: Pull docker image
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Create artifact
id: file
shell: bash
run: |
PRE_RAND="$( ${RAND} | md5sum | head -c 20; )"
PRE_DATE="$( date '+%s' )"
NAME="${PRE_RAND}-${PRE_DATE}.txt"
echo "somedata" > "${NAME}"
echo "::set-output name=path::${NAME}"
- name: upload artifact
uses: cytopia/[email protected]
with:
name: ${{ steps.file.outputs.path }}
path: ${{ steps.file.outputs.path }}
```
### Complex with retry logic
```yaml
on: [push]
jobs:
job1:
runs-on: ubuntu-latest
name: Pull docker image
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 0
# TRY-1
# export docker image to file
# upload file
# download file
# import downloaded file into docker
- name: upload docker image (try-1)
id: upload-1
uses: cytopia/[email protected]
continue-on-error: true
with:
name: php-fpm-8.1-work
path: php-fpm-8.1-work
pre_command: |
docker save devilbox/php-fpm:8.1-work | gzip > php-fpm-8.1-work
post_command: |
docker load -i {{download_path}}
# TRY-2
# export docker image to file
# upload file
# download file
# import downloaded file into docker
- name: upload docker image (try-2)
id: upload-2
uses: cytopia/[email protected]
with:
name: php-fpm-8.1-work
path: php-fpm-8.1-work
pre_command: |
docker save devilbox/php-fpm:8.1-work | gzip > php-fpm-8.1-work
post_command: |
docker load -i {{download_path}}
if: steps.upload-1.outcome == 'failure'
```
## :exclamation: Keep up-to-date with GitHub Dependabot
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot) has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem), to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file:
```yml
version: 2
updates:
# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
```
## :octocat: [cytopia](https://github.com/cytopia) GitHub Actions
| Name | Description |
|----------------------------------|-------------|
| [docker-tag-action] | Determines Docker tags based on git branch, commit or git tag |
| [git-ref-matrix-action] | Create stringified JSON list of git refs to be used as a build matrix |
| [shell-command-retry-action] | Retries shell commands to avoid failing pipelines due to network issues |
| [upload-artifact-verify-action] | Upload artifact and verifies it by downloading it again |
| [upload-artifact-retry-action] | Retries `upload-artifact-verify-action` |
| [download-artifact-retry-action] | Download artifact with retry functionality |
[docker-tag-action]: https://github.com/cytopia/docker-tag-action
[git-ref-matrix-action]: https://github.com/cytopia/git-ref-matrix-action
[shell-command-retry-action]: https://github.com/cytopia/shell-command-retry-action
[upload-artifact-verify-action]: https://github.com/cytopia/upload-artifact-verify-action
[upload-artifact-retry-action]: https://github.com/cytopia/upload-artifact-retry-action
[download-artifact-retry-action]: https://github.com/cytopia/download-artifact-retry-action
## :page_facing_up: License
**[MIT License](LICENSE)**
Copyright (c) 2022 [cytopia](https://github.com/cytopia)