Skip to content

Commit

Permalink
Updated Readme.md with latest features
Browse files Browse the repository at this point in the history
  • Loading branch information
panuoksala authored Jan 26, 2022
1 parent 0762d20 commit 1c5c850
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ Install the plugin from Stream Deck Store and create Azure DevOps PAT token with

### Configurations

**Organization name:** The name of the Azure DevOps organization. The Azure DevOps url contains the organization name and it is best to get it from there: *dev.azure.com/{organization name}.*\
**Title:** Overlay text on top of the Azure DevOps icon.\
**Organization URL:** The Azure DevOps URL with or without https://. For example : *dev.azure.com/{your organization}.*\
**Project name:** The name of the project like it is in the project URL. Spaces must be replaced with %20. For example "Example Project" is *Example%20Project*\
**PAT:** The personal access token with read and execute permissions for build and release pipelines. Dont create PAT tokens with full access!\
**Pipeline type:** Build or release depending on what kind of action you want to trigger\
**Definition Id:** The build or release definition ID. Open the pipeline in edit mode and copy the ID from URL. For example: *https://dev.azure.com/{organization name}/{projectname}/_apps/hub/ms.vss-ciworkflow.build-ci-hub?_a=edit-build-definition&id={definition ID}*
**Definition Id:** The build or release definition ID. Open the pipeline in edit mode and copy the ID from URL. For example: *https://dev.azure.com/{organization name}/{projectname}/_apps/hub/ms.vss-ciworkflow.build-ci-hub?_a=edit-build-definition&id={definition ID}*\
**Branch name:** Leave empty to use pipelines default branch, or specify branch name that you want to build.\
**Tap action:** What happens when StreamDeck button is pressed. Do nothing, Check build/release status or start build/release.\
**Long press action:** What happens if the StreamDeck button is pressed over one second. Do nothing, Check build/release status or start build/release.\
**Status update frequency:** How often the build/release status is requested automatically from Azure DevOps. Makes API calls with given interval.\
**Errors:** Shows the possible error message that is received when button action is invoked.

If the configuration is wrong the Stream Deck button will show exclamation icon indicating that some of the configuration is not correct. Check configuration and try again.\
On success build or release init the Stream Deck button will show OK sign for a short while.
Expand Down

0 comments on commit 1c5c850

Please sign in to comment.