This is a GitHub Action to create a release in Octopus Deploy. It requires the Octopus CLI; please ensure to include install-octopus-cli-action in your workflow (example below) before using this GitHub Action.

A release is a snapshot of the deployment process and the associated assets (packages, scripts, variables) as they existed when the release was created. The release is given a version number, and you can deploy that release as many times as you need to, even if parts of the deployment process have changed since the release was created (those changes will be included in future releases but not in this version).

When you deploy the release, you are executing the deployment process with all the associated details, as they existed when the release was created.

More information about releases in Octopus Deploy:

• Releases
• Create release

Incorporate the following actions in your workflow to create a release in Octopus Deploy using an API key, a target instance (i.e. server), and a project:

steps:
  - uses: actions/checkout@v3
  - name: Install Octopus CLI 🐙
    uses: OctopusDeploy/[email protected]
    with:
      version: latest
  - name: Create a release in Octopus Deploy 🐙
    uses: OctopusDeploy/[email protected]
    with:
      api_key: ${{ secrets.API_KEY }}
      project: 'Projects-123'
      server: ${{ secrets.SERVER }}

Here's an example that provides a username and password to authenticate to Octopus Deploy:

steps:
  - uses: actions/checkout@v3
  - name: Install Octopus CLI 🐙
    uses: OctopusDeploy/[email protected]
    with:
      version: latest
  - name: Create a release in Octopus Deploy 🐙
    uses: OctopusDeploy/[email protected]
    with:
      password: ${{ secrets.PASSWORD }}
      project: 'Projects-123'
      server: ${{ secrets.SERVER }}
      username: ${{ secrets.USERNAME }}

The following inputs are optional: