Skip to content

Commit

Permalink
chore: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbristowe committed Jun 27, 2022
1 parent 3ab01b5 commit 08965a5
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,23 @@
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._

- **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._

## 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_HOST: ${{ secrets.OCTOPUS_URL }}
OCTOPUS_API_KEY: ${{ secrets.OCTOPUS_API_KEY }}
OCTOPUS_SPACE: '<spaceid>'
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: '<spaceid>' # space ID to target
steps:
- uses: actions/checkout@v2
- name: Push build information to Octopus Deploy 🐙
Expand Down

0 comments on commit 08965a5

Please sign in to comment.