Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Adds support for authenticating with access token #20

Merged
merged 10 commits into from
Aug 23, 2023
Merged

feat: Adds support for authenticating with access token #20

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b9c4fff
Adds support for authenticating with access token
geofflamrock Aug 22, 2023
b3bd5d0
Update to release client
geofflamrock Aug 22, 2023
310e435
Update readme
geofflamrock Aug 22, 2023
a3fd550
Fix readme
geofflamrock Aug 23, 2023
ce2020f
Discard changes to README.md
geofflamrock Aug 23, 2023
c7d69c5
Discard changes to action.yml
geofflamrock Aug 23, 2023
3dea3bd
Remove access_token inputs and revert error messages
geofflamrock Aug 23, 2023
8cce53f
Fix error message
geofflamrock Aug 23, 2023
fa3fb0e
Commit to make GHA triggers fire
geofflamrock Aug 23, 2023
7d37fa4
Revert previous commit
geofflamrock Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 16 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,25 @@ steps:

## ✍️ 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. |
| 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_ACCESS_TOKEN` | The access token used to access Octopus Deploy. An access token can be obtained via OpenID Connect by using the `OctopusDeploy/login` action. Please note that this feature is currently under development and may not be available on your Octopus instance yet. |
| `OCTOPUS_SPACE` | The Name of a space within which this command will be executed. |

## 📥 Inputs

| Name | Description |
| :----------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `server_task_id` | **Required.** The execution task id to watch/wait for. |
| `polling_interval` | How frequently, in seconds, to check the status. (Default: 10s) |
| `timeout_after` | Duration, in seconds, to allow for completion before timing out. (Default: 600s) |
| `hide_progress` | Whether to hide the progress of the task. (Default: false) |
| `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. |
| Name | Description |
| :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `server_task_id` | **Required.** The execution task id to watch/wait for. |
| `polling_interval` | How frequently, in seconds, to check the status. (Default: 10s) |
| `timeout_after` | Duration, in seconds, to allow for completion before timing out. (Default: 600s) |
| `hide_progress` | Whether to hide the progress of the task. (Default: false) |
| `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. |
| `access_token` | The access token used to access Octopus Deploy. An API key is required, but you may also use the OCTOPUS_ACCESS_TOKEN environment variable. An access token can be obtained via OpenID Connect by using the `OctopusDeploy/login` action. Please note that this feature is currently under development and may not be available on your Octopus instance yet. |
| `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. |

## 📤 Outputs

Expand Down
4 changes: 3 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ inputs:
server:
description: '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:
description: '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.'
description: 'The API key used to access Octopus Deploy. One of API key or Access Token are required, but you may also use the OCTOPUS_API_KEY environment variable. It is strongly recommended that this value retrieved from a GitHub secret.'
access_token:
description: 'The access token used to access Octopus Deploy. One of API key or Access Token are required, to obtain an access token please use the `OctopusDeploy/login` action. You may also use the OCTOPUS_ACCESS_TOKEN environment variable if you are obtaining a token another way.'
space:
description: '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.'

Expand Down
Loading