This is a GitHub Action to push build information to Octopus Deploy.
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.
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:
env:
OCTOPUS_API_KEY: ${{ secrets.OCTOPUS_API_KEY }} # API key used with Octopus Deploy instance
OCTOPUS_HOST: ${{ secrets.OCTOPUS_HOST }} # address of Octopus Deploy instance (i.e. https://demo.octopus.app)
OCTOPUS_SPACE: '<spacename>' # 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@v1
with:
packages: |
'<packageId1>'
version: '<versionofpackages>'
The following inputs are required:
Name | Description | Default |
---|---|---|
packages |
A multi-line list of packages to push build information to Octopus Deploy. | |
version |
The version of the package(s). |
The following inputs are optional:
Name | Description | Default |
---|---|---|
branch |
The branch name, if omitted the GitHub ref will be used. | |
debug |
Logs the build information data. | false |
overwrite_mode |
Determines the action to perform with build information if it already exists in the repository. Valid input values are FailIfExists , OverwriteExisting , and IgnoreIfExists . |
FailIfExists |
Contributions are welcome! โค๏ธ Please read our Contributing Guide for information about how to get involved in this project.