aioxyz/Railway PR Deploy Action
Creates an environment with provided environment variables and deploys them to Railway.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| MODE | The mode the action should run in - valid options are CREATE, DESTROY, CONNECT | no | CREATE |
| RAILWAY_API_TOKEN | Railway API Token | yes | — |
| PROJECT_ID | The id of the project to create environments on. Can be found on Settings -> General page | yes | — |
| SRC_ENVIRONMENT_NAME | The name of the environment to base the PRs off of. | no | — |
| SRC_ENVIRONMENT_ID | The id of the environment to base the PRs off of. If this is provided, SRC_ENVIRONMENT_NAME will be ignored. | no | — |
| SVC_ID | The service id that you want to connect, only relevant when MODE = CONNECT | no | — |
| SRC_IMG | The image to connect the source env to, only relevant when MODE = CONNECT | no | — |
| DEST_ENV_NAME | The name of the deployed PR environment. Usually a combination of pr-<PR_NUMBER>-<SHORT_COMMIT_HASH> passed inside of workflow | no | — |
| ENV_VARS | The environment variables to set on the PR environment. Should be a JSON object of key value pairs. e.g. {"DATABASE_URL": "test_url", "A": "abc", "D": "efg"} | no | — |
| API_SERVICE_NAME | The name of the API service to use for the PR environment. This is used to identify the domain of the deployed PR environment. | no | — |
| PROVIDER | The provider to use for the PR environment. Can be python, see https://nixpacks.com/docs/guides/configuring-builds for more info. | no | — |
| branch_name | The name of the branch | no | — |
| DEPLOYMENT_MAX_TIMEOUT | The maximum amount of time to wait for the deployment to finish. Defaults to 10 minutes. | no | — |
| DEPLOYMENT_ORDER | The order in which to deploy the services. Defaults to an empty array. | no | [] |
| IGNORE_SERVICE_REDEPLOY | A list of service names to ignore when redeploying the PR environment. This is useful for services that don't need to be redeployed on every PR deployment. | no | [] |
| VOLUMES | The volumes to create for the PR environment. Should be a JSON array of volume configs. e.g. [{path: "/path/to/volume", svc_name: "service1"}] | no | [] |
Outputs
| name | description |
|---|---|
| service_domain | The domain of the deployed PR environment |