faros-ai/faros-cicd-github-action
Faros CI/CD Github Action
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| api-key | Faros API Key | yes | — |
| event | Which CI/CD event the data is for. Can be either CI or CD | yes | — |
| run-id | Unique identifier of the job executing the CI or CD process. (Default: GITHUB_RUN_ID) | no | — |
| run-status | CI or CD step's job run status. (Success, Failed, Canceled, Queued, Running, Unknown, Custom) | yes | — |
| run-status-details | Any extra details about the status of the job run. | no | — |
| pull-request-number | Manually associate the commit to a specific pull request number | no | — |
| deploy | The URI of the deployment. Required for CD events. (source://app/env/deploy) | no | — |
| deploy-status | The status of the deployment. Required for CD events. (Success, Failed, Canceled, Queued, Running, RolledBack, Custom) | no | — |
| deploy-status-details | Any extra details about the status of the deployment. | no | — |
| deploy-app-platform | The platform the application is being deployed on. (e.g. ECS, K8s) | no | — |
| deploy-env-details | Any extra details about the deployment environment. | no | — |
| deploy-started-at | Deployment process start time in millis. (e.g. 1626804346019) | no | — |
| deploy-ended-at | Deployment process end time in millis. (e.g. 1626804346019) | no | — |
| deploy-tags | Tags associated with the deployment of the form: "key1:value1,key2:value2" | no | — |
| commit-uri | The URI of the commit that was built or deployed. (source://org/repo/sha) | no | — |
| artifact | The URI of the artifact that was built or deployed. (source://org/repo/artifact) | no | — |
| run-started-at | Job run start time in millis. (e.g. 1626804346019) | no | — |
| run-ended-at | Job run end time in millis. (e.g. 1626804346019) | no | — |
| pipeline-id | Unique identifier of the pipeline. | no | — |
| api-url | Faros API URL. | no | — |
| graph | Graph name to use when invoking Faros API. (Default: 'default') | no | — |
| no-artifact | Do not create an artifact in Faros. (Default: false) | no | — |
| debug | Enable debug mode. (Default: false) | no | — |
Outputs
no outputs