openrailassociation/Website Preview and Deployment via SSH
Deploys a built website artifact to a production and preview environment via SSH, with optional link checking.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 8, 2026
- License
- Apache 2.0
Pinned Snippet
uses: openrailassociation/web-deployment-action@866b5120138b7deddc2c1e3600bc897a39bd8c91 # v1.3.1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| artifact_name | The name of the uploaded artifact to deploy. | yes | — |
| condition_production | Condition to deploy to production. E.g., compare `github.ref` to `'refs/heads/main'`. See `.github/workflows/selftest.yml` for an example. | yes | — |
| domain_production | Domain name for the production deployment, e.g. https://example.com | yes | — |
| domain_preview | Domain name for the preview deployment, e.g. https://preview.example.com | yes | — |
| dir_base | Remote base directory (e.g. /var/www/virtual) | yes | — |
| dir_production | Full path for production deployment | yes | — |
| dir_preview_base | Preview base domain (e.g. preview) | yes | — |
| dir_preview_subdir | Preview subdir (e.g. pr-123) | yes | — |
| ssh_host | SSH hostname (e.g. webspace.example.org) | yes | — |
| ssh_user | SSH username | yes | — |
| ssh_key | SSH private key for authenticating with the deployment server | yes | — |
| ssh_port | SSH port | no | 22 |
| ssh_timeout | SSH connection timeout (e.g. 1m) | no | 1m |
| ssh_command_timeout | SSH command timeout (e.g. 2m) | no | 2m |
| ssh_rm | Remove remote directory before deploying (true/false) | no | true |
| ssh_strip_components | How many path components to strip (for tar/scp unpacking) | no | 1 |
| linkchecker_enabled | Enable link checker (true/false) | no | true |
| linkchecker_exclude | Comma-separated list of domains to exclude from link checker | no | "" |
| linkchecker_include_fragments | Include anchor fragments in link checking | no | true |
| linkchecker_offline | Only check local/relative links, do not fetch remote links (true/false) | no | false |
| linkchecker_max_concurrency | Max concurrent requests for link checker | no | 1 |
| linkchecker_user_agent | User-Agent for link checking | no | Mozilla/5.0 (Windows NT 10.0; Win64; x64) Apple WebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36 |
| linkchecker_retry_times | Retry delay in seconds for link checking | no | 5 |
| linkchecker_fail_on_errors | Fail workflow on link check errors (true/false) | no | false |
| linkchecker_verbose | Turn on verbose linkchecker logging in action logs (true/false) | no | false |
| linkchecker_extra_args | Extra arguments to pass to the link checker (e.g. --some-flag value) | no | "" |
| sticky_comment_enabled | Whether to enable sticky comments for the pull request. Defaults to true. | no | true |
| step_summary_enabled | Whether to enable step summaries in the GitHub Actions UI. Defaults to true. | no | true |
| gh_deployment | Name of the optional GitHub deployment to create. Requires the deployments permission. Defaults to empty, in which case no deployment is created. | no | "" |
Outputs
| name | description |
|---|---|
| url | The URL of the deployed production or preview website |