{"id":21313990,"url":"https://github.com/octopusdeploy/push-build-information-action","last_synced_at":"2025-07-12T01:31:03.393Z","repository":{"id":36955182,"uuid":"502813257","full_name":"OctopusDeploy/push-build-information-action","owner":"OctopusDeploy","description":"| Public |  :octocat: GitHub Action to Push Build Information to Octopus Deploy","archived":false,"fork":false,"pushed_at":"2024-05-23T00:49:31.000Z","size":2093,"stargazers_count":8,"open_issues_count":10,"forks_count":8,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-05-23T01:43:48.093Z","etag":null,"topics":["public"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/push-build-information-to-octopus-deploy","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OctopusDeploy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-06-13T05:09:59.000Z","updated_at":"2024-05-30T03:04:07.204Z","dependencies_parsed_at":"2023-02-19T04:00:45.682Z","dependency_job_id":"ce015f74-f9c9-4746-a4da-4bc6d7c38fd2","html_url":"https://github.com/OctopusDeploy/push-build-information-action","commit_stats":{"total_commits":90,"total_committers":12,"mean_commits":7.5,"dds":0.7222222222222222,"last_synced_commit":"493905fe1cc3402d8474ded220e7f4f4c8181912"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fpush-build-information-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fpush-build-information-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fpush-build-information-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctopusDeploy%2Fpush-build-information-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OctopusDeploy","download_url":"https://codeload.github.com/OctopusDeploy/push-build-information-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225778856,"owners_count":17522710,"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":["public"],"created_at":"2024-11-21T18:09:39.962Z","updated_at":"2024-11-21T18:09:40.469Z","avatar_url":"https://github.com/OctopusDeploy.png","language":"TypeScript","readme":"# push-build-information-action\n\n\u003cimg alt= \"\" src=\"https://github.com/OctopusDeploy/push-build-information-action/raw/main/assets/github-actions-octopus.png\" /\u003e\n\nThis is a GitHub Action to push build information to [Octopus Deploy](https://octopus.com/).\n\nThis action captures the following build information:\n\n- **BuildNumber**: _The unique ID of the build that was triggered._\n- **BuildUrl**: _The link to the build that was triggered._\n- **Branch**: _The branch or tag name that triggered the build._\n- **VcsRoot**: _The URL to the GitHub repository._\n- **VcsCommitNumber**: _The commit SHA that triggered the build._\n- **Commits**: _List of commits that was part of the build._\n  - **Please note:** Commits will only be included when a workflow is triggered by a `push` event.\n\n## Examples\n\nIncorporate the following actions in your workflow to push build information to Octopus Deploy using an API key, a target instance (i.e. `server`), and a package:\n\n```yml\nenv:\n  OCTOPUS_URL: ${{ secrets.OCTOPUS_URL }} # address of Octopus Deploy instance (i.e. https://demo.octopus.app)\n  OCTOPUS_API_KEY: ${{ secrets.OCTOPUS_API_KEY }} # API key used with Octopus Deploy instance\n  OCTOPUS_SPACE: '\u003cspacename\u003e' # or you can specify a Space ID\nsteps:\n  - uses: actions/checkout@v2\n  - name: Push build information to Octopus Deploy 🐙\n    uses: OctopusDeploy/push-build-information-action@v3\n    with:\n      packages: |\n        \u003cpackageId1\u003e\n      version: '\u003cversionofpackages\u003e'\n```\n\n## 📥 Environment Variables\n\n| Name              | Description                                                                                                                                          |\n| :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `OCTOPUS_URL`     | The base URL hosting Octopus Deploy (i.e. `https://octopus.example.com`). It is strongly recommended that this value retrieved from a GitHub secret. |\n| `OCTOPUS_API_KEY` | The API key used to access Octopus Deploy. It is strongly recommended that this value retrieved from a GitHub secret.                                |\n| `OCTOPUS_SPACE`   | The Name of a space within which this command will be executed.                                                                                      |\n\n## 📥 Inputs\n\n| Name             | Description                                                                                                                                                                                                  |\n| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `packages`       | A multi-line list of packages to push build information to Octopus Deploy.                                                                                                                                   |\n| `version`        | The version of the package(s).                                                                                                                                                                               |\n| `branch`         | The branch name, if omitted the GitHub ref will be used.                                                                                                                                                     |\n| `overwrite_mode` | Determines the action to perform with build information if it already exists in the repository. Valid input values are `FailIfExists` (default), `OverwriteExisting`, and `IgnoreIfExists`.                  |\n| `server`         | The instance URL hosting Octopus Deploy (i.e. \"https://octopus.example.com/\"). The instance URL is required, but you may also use the OCTOPUS_URL environment variable.                                      |\n| `api_key`        | The API key used to access Octopus Deploy. An API key is required, but you may also use the OCTOPUS_API_KEY environment variable. It is strongly recommended that this value retrieved from a GitHub secret. |\n| `space`          | The name of a space within which this command will be executed. The space name is required, but you may also use the OCTOPUS_SPACE environment variable.                                                     |\n\n## 🤝 Contributions\n\nContributions are welcome! :heart: Please read our [Contributing Guide](.github/CONTRIBUTING.md) for information about how to get involved in this project.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Fpush-build-information-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctopusdeploy%2Fpush-build-information-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctopusdeploy%2Fpush-build-information-action/lists"}