Skip to content

Commit 348ded2

Browse files
committed
Update docs and variable names
1 parent 6bd6340 commit 348ded2

File tree

2 files changed

+21
-52
lines changed

2 files changed

+21
-52
lines changed

README.md

Lines changed: 19 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,39 @@
11
# it-ae-actions-servicenow
22

3-
This composite action is used to modify a Service Now request
3+
This composite action is used to modify a TDx request (via an iPaaS flow)
44

55
## Example usages
66

7-
- Add a comment
8-
```yaml
9-
steps:
10-
- name: Update Service Now Request
11-
uses: tamu-edu/[email protected]
12-
with:
13-
sn-base-url: ${{ vars.SN_BASE_URL }}
14-
sn-username: ${{ secrets.SN_USERNAME }}
15-
sn-password: ${{ secrets.SN_PASSWORD }}
16-
action-version: v1.0
17-
sn-request-id: 99e15216db4fb114c02e6909139619d2
18-
sn-action: add_comment
19-
sn-input1: My comment
20-
github-token: ${{ secrets.GITHUB_TOKEN }}
21-
```
22-
23-
- Add a work note
24-
```yaml
25-
steps:
26-
- name: Update Service Now Request
27-
uses: tamu-edu/[email protected]
28-
with:
29-
sn-base-url: ${{ vars.SN_BASE_URL }}
30-
sn-username: ${{ secrets.SN_USERNAME }}
31-
sn-password: ${{ secrets.SN_PASSWORD }}
32-
action-version: v1.0
33-
sn-request-id: 99e15216db4fb114c02e6909139619d2
34-
sn-action: add_work_notes
35-
sn-input1: My work note
36-
github-token: ${{ secrets.GITHUB_TOKEN }}
37-
```
387

398
- Close a Request
409
```yaml
4110
steps:
42-
- name: Update Service Now Request
43-
uses: tamu-edu/it-ae-actions-servicenow@v1.0
11+
- name: Close TDx Request
12+
uses: tamu-edu/it-ae-actions-tdx@v1.0
4413
with:
45-
sn-base-url: ${{ vars.SN_BASE_URL }}
46-
sn-username: ${{ secrets.SN_USERNAME }}
47-
sn-password: ${{ secrets.SN_PASSWORD }}
14+
tdx-base-url: ${{ vars.TDX_BASE_URL }}
15+
tdx-account-id: ${{ secrets.TDX_ACCOUNT_ID }}
16+
tdx-secret: ${{ secrets.TDX_SECRET }}
4817
action-version: v1.0
49-
sn-request-id: 99e15216db4fb114c02e6909139619d2
50-
sn-action: close_request
51-
sn-input1: ""
18+
tdx-request-id: 111
19+
tdx-action: close_request
20+
tdx-input1: ""
5221
github-token: ${{ secrets.GITHUB_TOKEN }}
5322
```
5423
55-
- Update a Request variable called 'resource_url':
24+
- Update a Request variable called 'resource_url' and close the request:
5625
```yaml
5726
steps:
58-
- name: Update Service Now Request
59-
uses: tamu-edu/it-ae-actions-servicenow@v1.0
27+
- name: Update TDx Request and Close
28+
uses: tamu-edu/it-ae-actions-tdx@v1.0
6029
with:
61-
sn-base-url: ${{ vars.SN_BASE_URL }}
62-
sn-username: ${{ secrets.SN_USERNAME }}
63-
sn-password: ${{ secrets.SN_PASSWORD }}
30+
tdx-base-url: ${{ vars.TDX_BASE_URL }}
31+
tdx-account-id: ${{ secrets.TDX_ACCOUNT_ID }}
32+
tdx-secret: ${{ secrets.TDX_SECRET }}
6433
action-version: v1.0
65-
sn-request-id: 99e15216db4fb114c02e6909139619d2
66-
sn-action: update_request_variable
67-
sn-input1: resource_url
68-
sn-input2: Testing composite action 2
34+
tdx-request-id: 112
35+
tdx-action: update_request_variable_and_close_request
36+
tdx-input1: resource_url
37+
tdx-input2: http://some.resource.url
6938
github-token: ${{ secrets.GITHUB_TOKEN }}
7039
```

action.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ inputs:
1616
title: TDx Base URL
1717
description: The base URL of the TDx instance
1818
required: true
19-
tdx-account_id:
19+
tdx-account-id:
2020
type: string
2121
title: TDx Account ID
2222
description: The username to use for authentication
@@ -87,7 +87,7 @@ runs:
8787
shell: bash
8888
env:
8989
TDX_BASE_URL: ${{ inputs.tdx-base-url }}
90-
TDX_ACCOUNT_ID: ${{ inputs.tdx-account_id }}
90+
TDX_ACCOUNT_ID: ${{ inputs.tdx-account-id }}
9191
TDX_SECRET: ${{ inputs.tdx-secret }}
9292
run: |
9393
ARGS="--request_id ${{ inputs.tdx-request-id }}"

0 commit comments

Comments
 (0)