{"id":19435573,"url":"https://github.com/cssnr/push-artifacts-action","last_synced_at":"2026-04-11T21:05:15.067Z","repository":{"id":189858138,"uuid":"681389730","full_name":"cssnr/push-artifacts-action","owner":"cssnr","description":"Push Artifacts Github Action","archived":false,"fork":false,"pushed_at":"2024-09-26T08:17:13.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-07T21:11:26.701Z","etag":null,"topics":["actions"],"latest_commit_sha":null,"homepage":"https://cssnr.github.io","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cssnr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-21T23:11:18.000Z","updated_at":"2024-09-26T08:17:17.000Z","dependencies_parsed_at":"2025-01-07T21:10:37.784Z","dependency_job_id":"99a3d526-6ada-47b5-97a6-d6dfdad2e4e8","html_url":"https://github.com/cssnr/push-artifacts-action","commit_stats":null,"previous_names":["hosted-domains/workflows","hosted-domains/push-artifacts-action","cssnr/push-artifacts-action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fpush-artifacts-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fpush-artifacts-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fpush-artifacts-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cssnr%2Fpush-artifacts-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cssnr","download_url":"https://codeload.github.com/cssnr/push-artifacts-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240619428,"owners_count":19830204,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions"],"created_at":"2024-11-10T15:07:05.315Z","updated_at":"2026-04-11T21:05:15.059Z","avatar_url":"https://github.com/cssnr.png","language":"Shell","funding_links":["https://ko-fi.com/cssnr"],"categories":[],"sub_categories":[],"readme":"[![GitHub Tag Major](https://img.shields.io/github/v/tag/cssnr/push-artifacts-action?sort=semver\u0026filter=!v*.*\u0026logo=git\u0026logoColor=white\u0026labelColor=585858\u0026label=%20)](https://github.com/cssnr/push-artifacts-action/tags)\n[![GitHub Tag Minor](https://img.shields.io/github/v/tag/cssnr/push-artifacts-action?sort=semver\u0026filter=!v*.*.*\u0026logo=git\u0026logoColor=white\u0026labelColor=585858\u0026label=%20)](https://github.com/cssnr/push-artifacts-action/releases)\n[![GitHub Release Version](https://img.shields.io/github/v/release/cssnr/push-artifacts-action?logo=git\u0026logoColor=white\u0026labelColor=585858\u0026label=%20)](https://github.com/cssnr/push-artifacts-action/releases/latest)\n[![Workflow Release](https://img.shields.io/github/actions/workflow/status/cssnr/push-artifacts-action/release.yaml?logo=cachet\u0026label=release)](https://github.com/cssnr/push-artifacts-action/actions/workflows/release.yaml)\n[![Workflow Lint](https://img.shields.io/github/actions/workflow/status/cssnr/push-artifacts-action/lint.yaml?logo=cachet\u0026label=lint)](https://github.com/cssnr/push-artifacts-action/actions/workflows/lint.yaml)\n[![GitHub Last Commit](https://img.shields.io/github/last-commit/cssnr/push-artifacts-action?logo=github\u0026label=updated)](https://github.com/cssnr/push-artifacts-action/pulse)\n[![Codeberg Last Commit](https://img.shields.io/gitea/last-commit/cssnr/push-artifacts-action/master?gitea_url=https%3A%2F%2Fcodeberg.org%2F\u0026logo=codeberg\u0026logoColor=white\u0026label=updated)](https://codeberg.org/cssnr/push-artifacts-action)\n[![GitHub Contributors](https://img.shields.io/github/contributors-anon/cssnr/push-artifacts-action?logo=github)](https://github.com/cssnr/push-artifacts-action/graphs/contributors)\n[![GitHub Repo Size](https://img.shields.io/github/repo-size/cssnr/push-artifacts-action?logo=bookstack\u0026logoColor=white\u0026label=repo%20size)](https://github.com/cssnr/push-artifacts-action?tab=readme-ov-file#readme)\n[![GitHub Top Language](https://img.shields.io/github/languages/top/cssnr/push-artifacts-action?logo=htmx)](https://github.com/cssnr/push-artifacts-action)\n[![GitHub Discussions](https://img.shields.io/github/discussions/cssnr/push-artifacts-action?logo=github)](https://github.com/cssnr/push-artifacts-action/discussions)\n[![GitHub Forks](https://img.shields.io/github/forks/cssnr/push-artifacts-action?style=flat\u0026logo=github)](https://github.com/cssnr/push-artifacts-action/forks)\n[![GitHub Repo Stars](https://img.shields.io/github/stars/cssnr/push-artifacts-action?style=flat\u0026logo=github)](https://github.com/cssnr/push-artifacts-action/stargazers)\n[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat\u0026logo=github\u0026label=org%20stars)](https://cssnr.github.io/)\n[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord\u0026logoColor=white\u0026label=discord\u0026color=7289da)](https://discord.gg/wXy6m2X8wY)\n[![Ko-fi](https://img.shields.io/badge/Ko--fi-72a5f2?logo=kofi\u0026label=support)](https://ko-fi.com/cssnr)\n\n# Push Artifacts Action\n\n- [Inputs](#Inputs)\n  - [Permissions](#Permissions)\n- [Examples](#Examples)\n- [Tags](#Tags)\n- [Support](#Support)\n- [Contributing](#Contributing)\n\nThis is really just a POC, but works and is in use. While it does rsync artifacts to a remote host, it is designed for\nscreenshots because it creates a [swiper.js](https://github.com/nolimits4web/swiper) index.html with all the files\nsynced and if served from a web server can be viewed in the browser.\n\nWill rsync the `source` (directory in the build) to `host`@`user` with `pass` on `port` to `dest` remote directory and\nappend the `GITHUB_REPOSITORY` (org/repo) followed by `GITHUB_RUN_NUMBER` then `GITHUB_RUN_ATTEMPT` and optionally send\na notification to a Discord `webhook` or comment on the PR prepending the `webhost` to the path.\n\n\u003e [!WARNING]  \n\u003e This action and this GitHub repository will soon be renamed before `v1.0.0` is published.\n\n## Inputs\n\n| Input               | Default    | Input\u0026nbsp;Description |\n| :------------------ | :--------- | :--------------------- |\n| source              | _Required_ | Source Directory       |\n| [dest](#dest)       | `/static`  | Destination Directory  |\n| host                | _Required_ | RSYNC Host             |\n| user                | _Required_ | RSYNC User             |\n| pass                | _Required_ | RSYNC Pass             |\n| port                | `22`       | RSYNC Port             |\n| [webhost](#webhost) | -          | HTTP Web Host for URL  |\n| [webhook](#webhook) | -          | Discord Webhook        |\n| comment             | `true`     | Add a Comment to PRs   |\n| token               | -          | For use with a PAT     |\n\nFor more details see [action.yml](action.yml) and [src/main.sh](src/main.sh).\n\n#### dest\n\nRemote destination directory that should be the root of your web server directory.\nThe full remote path will be {dest}/{owner}/{repo}/{run#}\n\n#### webhost\n\nWeb host where the `dest` is available at. The full URL will be {webhost}/{owner}/{repo}/{run#}\n\n#### webhook\n\nA Discord Webhook URL that if provided will be posted to.\n\n```yaml\n- name: 'Push Artifacts'\n  uses: cssnr/push-artifacts-action@master\n  with:\n    source: 'tests/screenshots'\n    dest: '/static'\n    host: ${{ secrets.RSYNC_HOST }}\n    user: ${{ secrets.RSYNC_USER }}\n    pass: ${{ secrets.RSYNC_PASS }}\n    port: ${{ secrets.RSYNC_PORT }}\n    webhost: 'https://example.com'\n    webhook: ${{ secrets.DISCORD_WEBHOOK }}\n    token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### Permissions\n\nThis action requires the following permissions to add pull request comments:\n\n```yaml\npermissions:\n  pull-requests: write\n```\n\nPermissions documentation for [Workflows](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/controlling-permissions-for-github_token) and [Actions](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication).\n\n## Outputs\n\n| Output | Output\u0026nbsp;Description |\n| :----- | :---------------------- |\n| url    | Full Screen Shots URL   |\n\nYou must provide the `webhost` input for this to function properly.\n\n## Examples\n\n```yaml\nname: 'Push Artifacts Test'\n\non:\n  push:\n    branches:\n      - master\n  pull_request:\n    branches:\n      - master\n\njobs:\n  test:\n    name: 'Test'\n    runs-on: ubuntu-latest\n    timeout-minutes: 5\n    permissions:\n      pull-requests: write\n\n    steps:\n      - name: 'Checkout'\n        uses: actions/checkout@v4\n\n      - name: 'Push Artifacts'\n        uses: cssnr/push-artifacts-action@master\n        with:\n          source: 'tests/screenshots'\n          dest: '/static'\n          host: ${{ secrets.RSYNC_HOST }}\n          user: ${{ secrets.RSYNC_USER }}\n          pass: ${{ secrets.RSYNC_PASS }}\n          port: ${{ secrets.RSYNC_PORT }}\n          webhost: 'https://example.com'\n          webhook: ${{ secrets.DISCORD_WEBHOOK }}\n          token: ${{ secrets.GITHUB_TOKEN }}\n```\n\nTo see this used in actual workflows, check out these examples:  \nhttps://github.com/django-files/django-files/blob/master/.github/workflows/test.yaml  \nhttps://github.com/cssnr/link-extractor/blob/master/.github/workflows/test.yaml\n\nFor more examples, you can check out other projects using this action:  \nhttps://github.com/cssnr/push-artifacts-action/network/dependents\n\n## Tags\n\nThe following rolling [tags](https://github.com/cssnr/push-artifacts-action/tags) are maintained.\n\n| Version\u0026nbsp;Tag                                                                                                                                                                                                           | Rolling | Bugs | Feat. |   Name    |  Target  | Example  |\n| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----: | :--: | :---: | :-------: | :------: | :------- |\n| [![GitHub Tag Major](https://img.shields.io/github/v/tag/cssnr/push-artifacts-action?sort=semver\u0026filter=!v*.*\u0026style=for-the-badge\u0026label=%20\u0026color=44cc10)](https://github.com/cssnr/push-artifacts-action/releases/latest) |   ✅    |  ✅  |  ✅   | **Major** | `vN.x.x` | `vN`     |\n| [![GitHub Tag Minor](https://img.shields.io/github/v/tag/cssnr/push-artifacts-action?sort=semver\u0026filter=!v*.*.*\u0026style=for-the-badge\u0026label=%20\u0026color=blue)](https://github.com/cssnr/push-artifacts-action/releases/latest) |   ✅    |  ✅  |  ❌   | **Minor** | `vN.N.x` | `vN.N`   |\n| [![GitHub Release](https://img.shields.io/github/v/release/cssnr/push-artifacts-action?style=for-the-badge\u0026label=%20\u0026color=red)](https://github.com/cssnr/push-artifacts-action/releases/latest)                           |   ❌    |  ❌  |  ❌   | **Micro** | `vN.N.N` | `vN.N.N` |\n\nYou can view the release notes for each version on the [releases](https://github.com/cssnr/push-artifacts-action/releases) page.\n\nThe **Major** tag is recommended. It is the most up-to-date and always backwards compatible.\nBreaking changes would result in a **Major** version bump. At a minimum you should use a **Minor** tag.\n\n# Support\n\nFor general help or to request a feature, see:\n\n- Q\u0026A Discussion: https://github.com/cssnr/push-artifacts-action/discussions/categories/q-a\n- Request a Feature: https://github.com/cssnr/push-artifacts-action/discussions/categories/feature-requests\n\nIf you are experiencing an issue/bug or getting unexpected results, you can:\n\n- Report an Issue: https://github.com/cssnr/push-artifacts-action/issues\n- Chat with us on Discord: https://discord.gg/wXy6m2X8wY\n- Provide General Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Push%20Artifacts)\n\nFor more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.github/blob/master/.github/SUPPORT.md#support).\n\n# Contributing\n\nPlease consider making a donation to support the development of this project\nand [additional](https://cssnr.com/) open source projects.\n\n[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cssnr)\n\nIf you would like to submit a PR, please review the [CONTRIBUTING.md](#contributing-ov-file).\n\nAdditionally, you can support other GitHub Actions I have published:\n\n- [Stack Deploy Action](https://github.com/cssnr/stack-deploy-action?tab=readme-ov-file#readme)\n- [Portainer Stack Deploy Action](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#readme)\n- [Docker Context Action](https://github.com/cssnr/docker-context-action?tab=readme-ov-file#readme)\n- [VirusTotal Action](https://github.com/cssnr/virustotal-action?tab=readme-ov-file#readme)\n- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action?tab=readme-ov-file#readme)\n- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action?tab=readme-ov-file#readme)\n- [Docker Tags Action](https://github.com/cssnr/docker-tags-action?tab=readme-ov-file#readme)\n- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action?tab=readme-ov-file#readme)\n- [JSON Key Value Check Action](https://github.com/cssnr/json-key-value-check-action?tab=readme-ov-file#readme)\n- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action?tab=readme-ov-file#readme)\n- [Cloudflare Purge Cache Action](https://github.com/cssnr/cloudflare-purge-cache-action?tab=readme-ov-file#readme)\n- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action?tab=readme-ov-file#readme)\n- [Package Changelog Action](https://github.com/cssnr/package-changelog-action?tab=readme-ov-file#readme)\n- [NPM Outdated Check Action](https://github.com/cssnr/npm-outdated-action?tab=readme-ov-file#readme)\n- [Label Creator Action](https://github.com/cssnr/label-creator-action?tab=readme-ov-file#readme)\n- [Algolia Crawler Action](https://github.com/cssnr/algolia-crawler-action?tab=readme-ov-file#readme)\n- [Upload Release Action](https://github.com/cssnr/upload-release-action?tab=readme-ov-file#readme)\n- [Check Build Action](https://github.com/cssnr/check-build-action?tab=readme-ov-file#readme)\n- [Web Request Action](https://github.com/cssnr/web-request-action?tab=readme-ov-file#readme)\n- [Get Commit Action](https://github.com/cssnr/get-commit-action?tab=readme-ov-file#readme)\n\n\u003cdetails\u003e\u003csummary\u003e❔ Unpublished Actions\u003c/summary\u003e\n\nThese actions are not published on the Marketplace, but may be useful.\n\n- [cssnr/draft-release-action](https://github.com/cssnr/draft-release-action?tab=readme-ov-file#readme) - Keep a draft release ready to publish.\n- [cssnr/env-json-action](https://github.com/cssnr/env-json-action?tab=readme-ov-file#readme) - Convert env file to json or vice versa.\n- [cssnr/push-artifacts-action](https://github.com/cssnr/push-artifacts-action?tab=readme-ov-file#readme) - Sync files to a remote host with rsync.\n- [smashedr/update-release-notes-action](https://github.com/smashedr/update-release-notes-action?tab=readme-ov-file#readme) - Update release notes.\n- [smashedr/combine-release-notes-action](https://github.com/smashedr/combine-release-notes-action?tab=readme-ov-file#readme) - Combine release notes.\n\n---\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\u003csummary\u003e📝 Template Actions\u003c/summary\u003e\n\nThese are basic action templates that I use for creating new actions.\n\n- [js-test-action](https://github.com/smashedr/js-test-action?tab=readme-ov-file#readme) - JavaScript\n- [py-test-action](https://github.com/smashedr/py-test-action?tab=readme-ov-file#readme) - Python\n- [ts-test-action](https://github.com/smashedr/ts-test-action?tab=readme-ov-file#readme) - TypeScript\n- [docker-test-action](https://github.com/smashedr/docker-test-action?tab=readme-ov-file#readme) - Docker Image\n\nNote: The `docker-test-action` builds, runs and pushes images to [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).\n\n---\n\n\u003c/details\u003e\n\nFor a full list of current projects to support visit: [https://cssnr.github.io/](https://cssnr.github.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssnr%2Fpush-artifacts-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcssnr%2Fpush-artifacts-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcssnr%2Fpush-artifacts-action/lists"}