{"id":22444965,"url":"https://github.com/alexcnichols/create-deployment-status","last_synced_at":"2026-04-16T14:03:46.022Z","repository":{"id":44042439,"uuid":"222390952","full_name":"alexcnichols/create-deployment-status","owner":"alexcnichols","description":"An Action to create deployment statuses via the GitHub Deployment API","archived":false,"fork":false,"pushed_at":"2023-01-04T13:16:09.000Z","size":1054,"stargazers_count":3,"open_issues_count":14,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-01T23:02:48.046Z","etag":null,"topics":["actions","deployment","deployment-automation","github","github-actions"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexcnichols.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}},"created_at":"2019-11-18T07:45:45.000Z","updated_at":"2023-03-25T16:59:08.000Z","dependencies_parsed_at":"2023-02-02T13:30:43.167Z","dependency_job_id":null,"html_url":"https://github.com/alexcnichols/create-deployment-status","commit_stats":{"total_commits":1,"total_committers":1,"mean_commits":1.0,"dds":0.0,"last_synced_commit":"f031a4484220bdf7458937ed933c49d61a5cf7cc"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":"actions/javascript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcnichols%2Fcreate-deployment-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcnichols%2Fcreate-deployment-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcnichols%2Fcreate-deployment-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexcnichols%2Fcreate-deployment-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexcnichols","download_url":"https://codeload.github.com/alexcnichols/create-deployment-status/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245832612,"owners_count":20679701,"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","deployment","deployment-automation","github","github-actions"],"created_at":"2024-12-06T03:11:14.552Z","updated_at":"2026-04-16T14:03:45.980Z","avatar_url":"https://github.com/alexcnichols.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action - Deployments (Status) API\n\nThis GitHub Action (written in JavaScript) wraps the [GitHub Deployment API](https://developer.github.com/v3/repos/deployments/), specifically the [Create a deployment status](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status) endpoint, to allow you to leverage GitHub Actions to create deployment status.\n\n\u003ca href=\"https://github.com/alexcnichols/create-deployment-status\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/alexcnichols/create-deployment-status/workflows/CI/badge.svg\"\u003e\u003c/a\u003e\n\n## Usage\n\n### Pre-requisites\n\nCreate a workflow `.yml` file in your repository's `.github/workflows` directory. An [example workflow](#example-workflow---create-a-deployment-status) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).\n\n### Inputs\n\nFor more information on these inputs, see the [API Documentation](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status)\n\n- `deployment_id`: The ID of the Deployment.\n- `state`: The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued`, `pending`, or `success`.\n- `environment_url`: Sets the URL for accessing your environment.\n\n### Outputs\n\nFor more information on these outputs, see the [API Documentation](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status) for an example of what these outputs look like\n\n- `id`: The deployment status ID\n\n### Example workflow - create a deployment status\n\nOn every `push` to a tag matching the pattern `v*`, [create a deployment](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status):\n\n```yaml\non:\n  push:\n    # Sequence of patterns matched against refs/tags\n    tags:\n      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10\n\nname: Create Deployment\n\njobs:\n  build:\n    name: Create Deployment\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout code\n        uses: actions/checkout@master\n      - name: Create Deployment\n        id: create_deployment\n        uses: alexcnichols/create-deployment@v1\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token\n        with:\n          environment: production\n\n        # Run the actual deployment\n\n      - name: Create Deployment Status\n        id: create_deployment_status\n        uses: alexcnichols/create-deployment-status@v1\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token\n        with:\n          deployment_id: ${{ steps.create_deployment.outputs.id }}\n          state: success\n          environment_url: https://alexcnichols.dev\n```\n\nThis will create a [Deployment Status](https://help.github.com/en/github/administering-a-repository/viewing-deployment-activity-for-your-repository). This uses the `GITHUB_TOKEN` provided by the [virtual environment](https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#github_token-secret), so no new token is needed.\n\n## Contributing\n\nWe would love you to contribute to `@alexcnichols/create-deployment-status`, pull requests are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) for more information.\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexcnichols%2Fcreate-deployment-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexcnichols%2Fcreate-deployment-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexcnichols%2Fcreate-deployment-status/lists"}