Skip to content

Commit

Permalink
initial
Browse files Browse the repository at this point in the history
  • Loading branch information
burtonr committed Jan 5, 2020
0 parents commit 95dc37f
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
31 changes: 31 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: OctopusDeploy Create Release
author: Burton Rheutan
description: Create a new OctopusDeploy release
inputs:
octopus_url:
description: 'URL of the OctopusDeploy server'
required: true
api_key:
description: 'OctopusDeploy API key'
required: true
project_name:
description: 'OctopusDeploy project to create the release for'
required: true
release_version:
description: 'The version to create the release for'
required: true
space_name:
description: 'The OctopusDeploy space that the project is in'
required: false
default: 'Default'
outputs:
release_id:
description: 'ID of the created release'
runs:
using: 'docker'
image: 'burtonr/[email protected]'
args:
- 'release'
branding:
icon: 'package'
color: 'blue'
49 changes: 49 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# OctopusDeploy GitHub Action for Creating a Release
This is a GitHub Action that will create a new "Release" in OctopusDeploy

**This is not an official OctopusDeploy project**

The "work" is done in the [octopus-action-client](https://github.com/burtonr/octopus-action-client) Docker container.

This repository is to create the `action.yml` and publish to the GitHub Actions Marketplace

## Inputs

### `octopus_url`

**Required** The full URL of your OctopusDeploy instance

> Example: `https://your.octopus.com/`
### `api_key`

**Required** The OctopusDeploy API key used to authenticate with your OctopusDeploy instance

More information here: [How to Create an API Key](https://octopus.com/docs/octopus-rest-api/how-to-create-an-api-key)

### `project_name`

**Required** The Project name to create the release for

### `release_version`

***Required** The version to use for the release

> Example: `"1.0.0"`
### `space_name`

_Optional_ The OctopusDeploy Space the project is located in

More information here: [Spaces](https://octopus.com/docs/administration/spaces)

## Example Usage

```yaml
uses: burtonr/octopus-release-action@master
with:
octopus_url: 'https://your.octopus.com'
api_key: ${{ secrets.OCTOPUS_API_KEY }}
project_name: 'Awesome Project'
release_version: ${{ github.ref }}
```

0 comments on commit 95dc37f

Please sign in to comment.