web-id-fr/Forge Review-app Clean Action
Clean a review-application on Laravel Forge
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| forge_api_token | Laravel Forge API key | yes | — |
| forge_organization | Laravel Forge organization slug | yes | — |
| forge_server_id | Laravel Forge server ID | yes | — |
| root_domain | Root domain under which to create review-app site | no | — |
| host | Site host of the review-app | no | — |
| prefix_with_pr_number | Use the pull-request number as host and database prefix when host is not manually defined | no | true |
| fqdn_prefix | Prefix the whole FQDN (e.g.: "app.") | no | — |
| pr_number | Manually define pull-request number | no | — |
| database_name | Database name of the review-app site | no | — |
| database_name_prefix | Database name prefix, useful for PostgreSQL that does not support digits (PR number) for first chars | — | — |
| cleanup_orphans | Enable "orphan cleanup" mode: ignore host/pr_number/database_name and discover+delete orphaned review-apps on the server | no | false |
| repository | GitHub repository ("owner/repo") to check PR state against. Required if cleanup_orphans is true. Defaults to GITHUB_REPOSITORY | no | — |
| github_token | GitHub token used to check PR state (repos/{repository}/pulls/{pr}). Required if cleanup_orphans is true | no | — |
| host_pattern | ERE regex (jq/grep -P compatible) used to identify review-app sites among all server sites. Defaults to a pattern derived from root_domain | no | — |
| dry_run | If true, only log the orphans that would be deleted, without deleting anything | no | false |
Outputs
| name | description |
|---|---|
| host | Host of the review-app (generated or forced one in inputs). Not used in cleanup_orphans mode |
| database_name | Database name of the review-app (generated or forced one in inputs). Not used in cleanup_orphans mode |
| orphans_found | Number of orphaned review-apps detected (cleanup_orphans mode only) |
| orphans_deleted | Number of orphaned review-apps actually deleted (cleanup_orphans mode only, 0 if dry_run) |
| orphans_json | JSON array of the orphaned sites processed (cleanup_orphans mode only) |