https://github.com/octopusdeploy/push-build-information-action
| Public | :octocat: GitHub Action to Push Build Information to Octopus Deploy
https://github.com/octopusdeploy/push-build-information-action
public
Last synced: 7 months ago
JSON representation
| Public | :octocat: GitHub Action to Push Build Information to Octopus Deploy
- Host: GitHub
- URL: https://github.com/octopusdeploy/push-build-information-action
- Owner: OctopusDeploy
- License: other
- Created: 2022-06-13T05:09:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T00:49:31.000Z (over 1 year ago)
- Last Synced: 2024-05-23T01:43:48.093Z (over 1 year ago)
- Topics: public
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/push-build-information-to-octopus-deploy
- Size: 2 MB
- Stars: 8
- Watchers: 6
- Forks: 8
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# push-build-information-action
This is a GitHub Action to push build information to [Octopus Deploy](https://octopus.com/).
This action captures the following build information:
- **BuildNumber**: _The unique ID of the build that was triggered._
- **BuildUrl**: _The link to the build that was triggered._
- **Branch**: _The branch or tag name that triggered the build._
- **VcsRoot**: _The URL to the GitHub repository._
- **VcsCommitNumber**: _The commit SHA that triggered the build._
- **Commits**: _List of commits that was part of the build._
- **Please note:** Commits will only be included when a workflow is triggered by a `push` event.
## Examples
Incorporate 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:
```yml
env:
OCTOPUS_URL: ${{ secrets.OCTOPUS_URL }} # address of Octopus Deploy instance (i.e. https://demo.octopus.app)
OCTOPUS_API_KEY: ${{ secrets.OCTOPUS_API_KEY }} # API key used with Octopus Deploy instance
OCTOPUS_SPACE: '' # or you can specify a Space ID
steps:
- uses: actions/checkout@v2
- name: Push build information to Octopus Deploy 🐙
uses: OctopusDeploy/push-build-information-action@v3
with:
packages: |
version: ''
```
## 📥 Environment Variables
| Name | Description |
| :---------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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. |
| `OCTOPUS_API_KEY` | The API key used to access Octopus Deploy. It is strongly recommended that this value retrieved from a GitHub secret. |
| `OCTOPUS_SPACE` | The Name of a space within which this command will be executed. |
## 📥 Inputs
| Name | Description |
| :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `packages` | A multi-line list of packages to push build information to Octopus Deploy. |
| `version` | The version of the package(s). |
| `branch` | The branch name, if omitted the GitHub ref will be used. |
| `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`. |
| `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. |
| `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. |
| `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. |
## 🤝 Contributions
Contributions are welcome! :heart: Please read our [Contributing Guide](.github/CONTRIBUTING.md) for information about how to get involved in this project.