Skip to content

Commit bfe57f5

Browse files
docs: update readme
1 parent 7a112dc commit bfe57f5

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# meshStack Auth Action
22

3-
This GitHub Action authenticates to the meshStack API to enable building block automation workflows.
3+
This GitHub Action authenticates to the meshStack API to enable building block automation workflows as well as other API interactions with meshStack.
44

55
## Overview
66

7-
This GitHub Action is designed to authenticate against the meshStack API. It helps you obtain an access token using client credentials, which can then be used to interact with the meshStack API securely. This action simplifies the process of obtaining and managing authentication tokens for your workflows.
7+
This action helps you obtain an access token using client credentials, which can then be used to interact with the meshStack API securely. This action simplifies the process of obtaining and managing authentication tokens for your workflows.
88

99
## Related Actions
1010

@@ -26,18 +26,34 @@ For more information about meshStack building blocks and GitHub Actions integrat
2626
- `client_id` (required): The client ID for the API.
2727
- `key_secret` (required): The key secret for the API.
2828

29-
### Outputs
29+
## Outputs
3030

3131
- `token_file`: Path to the file containing the authentication token
3232

3333
## Example Usage
3434

3535
```yaml
36-
- name: Setup meshStack bbrun
37-
id: setup-meshstack-auth
38-
uses: meshcloud/[email protected]
39-
with:
40-
base_url: ${{ vars.BUILDINGBLOCK_API_BASE_URL }}
41-
client_id: ${{ vars.BUILDINGBLOCK_API_CLIENT_ID }}
42-
key_secret: ${{ secrets.BUILDINGBLOCK_API_KEY_SECRET }}
36+
name: Deploy Building Block
37+
38+
on:
39+
workflow_dispatch:
40+
inputs:
41+
buildingBlockRunUrl:
42+
description: "URL to fetch the Building Block Run Object from"
43+
required: true
44+
45+
jobs:
46+
deploy:
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Checkout Code
50+
uses: actions/checkout@v4
51+
52+
- name: Setup meshStack auth
53+
id: setup-meshstack-auth
54+
uses: meshcloud/actions-meshstack-auth@v2
55+
with:
56+
base_url: ${{ vars.MESHSTACK_BASE_URL }}
57+
client_id: ${{ vars.MESHSTACK_API_CLIENT_ID }}
58+
key_secret: ${{ secrets.MESHSTACK_API_KEY_SECRET }}
4359
```

0 commit comments

Comments
 (0)