Skip to content

Commit 3d31e85

Browse files
jprinetjprinet
committed
CR follow-up
- rename signature to Terms of Service - Adjust Check event trigger log message - Adjust inner action tags
1 parent d89c9c8 commit 3d31e85

File tree

5 files changed

+46
-46
lines changed

5 files changed

+46
-46
lines changed

‎.github/workflows/test-terms-of-service-acceptance-run.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ jobs:
1717
with:
1818
tos-location: 'https://foo.bar/tos.html'
1919
white-list: '*'
20-
signature-branch: ${{ github.event.repository.default_branch }}
21-
signature-location: '.github/develocity-tos.json'
20+
tos-acceptance-file-branch: ${{ github.event.repository.default_branch }}
21+
tos-acceptance-file: '.github/develocity-tos.json'

‎README.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -90,25 +90,25 @@ These event allows access to the repository secrets (_Develocity Access Key_) wh
9090
**Permissions**:
9191

9292
The following permissions are required for this action to operate:
93-
- `contents: write`: to create/edit the signature file
93+
- `contents: write`: to create/edit the Terms of Service acceptance file
9494
- `pull-requests: write`: to comment the pull-request
9595

9696
**Action inputs**:
9797

98-
| Name | Description | Default |
99-
|------------------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
100-
| `build-workflow-filename` | Filename of the workflow using `maven-build-scan/save` (called upon pull-request submission) | |
101-
| `tos-location` | Terms Of Service location (URL) | |
102-
| `develocity-url` | Develocity URL | |
103-
| `develocity-access-key` | *Optional*: Develocity access key | |
104-
| `develocity-allow-untrusted` | *Optional*: Develocity allow-untrusted flag | `false` |
105-
| `signature-branch` | *Optional*: Git branch where the signature file will be stored | `${{ github.event.repository.default_branch }}` |
106-
| `signature-location` | *Optional*: Signature file location | `.github/develocity-tos.json` |
107-
| `pr-comment-tos-acceptance-missing` | *Optional*: pull-request comment added when Terms of Service have not previously been accepted | `Please accept [Develocity Terms Of Service]({0}) to get your pull-request Build Scan published by commenting this pull-request with the following message:` |
108-
| `pr-comment-tos-acceptance-request` | *Optional*: pull-request comment to accept the Terms of Service | `I have read Develocity Terms Of Service and I hereby accept the Terms` |
109-
| `pr-comment-tos-acceptance-confirmation` | *Optional*: pull-request comment added when Terms of Service are accepted | `All Contributors have accepted Develocity Terms Of Service.` |
110-
| `white-list` | *Optional*: CSV List of users not required to accept the Terms of Service | `''` |
111-
| `github-token` | *Optional*: Github token | `${{ github.token }}` |
98+
| Name | Description | Default |
99+
|-------------------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
100+
| `build-workflow-filename` | Filename of the workflow using `maven-build-scan/save` (called upon pull-request submission) | |
101+
| `tos-location` | Terms Of Service location (URL) | |
102+
| `develocity-url` | Develocity URL | |
103+
| `develocity-access-key` | *Optional*: Develocity access key | |
104+
| `develocity-allow-untrusted` | *Optional*: Develocity allow-untrusted flag | `false` |
105+
| `tos-acceptance-file-branch` | *Optional*: Git branch where the Terms of Service acceptance file will be stored | `${{ github.event.repository.default_branch }}` |
106+
| `tos-acceptance-file` | *Optional*: Terms of Service acceptance file location | `.github/develocity-tos.json` |
107+
| `pr-comment-tos-acceptance-missing` | *Optional*: pull-request comment added when Terms of Service have not previously been accepted | `Please accept [Develocity Terms Of Service]({0}) to get your pull-request Build Scan published by commenting this pull-request with the following message:` |
108+
| `pr-comment-tos-acceptance-request` | *Optional*: pull-request comment to accept the Terms of Service | `I have read Develocity Terms Of Service and I hereby accept the Terms` |
109+
| `pr-comment-tos-acceptance-confirmation` | *Optional*: pull-request comment added when Terms of Service are accepted | `All Contributors have accepted Develocity Terms Of Service.` |
110+
| `white-list` | *Optional*: CSV List of users not required to accept the Terms of Service | `''` |
111+
| `github-token` | *Optional*: Github token | `${{ github.token }}` |
112112

113113
**Usage**:
114114

@@ -232,22 +232,22 @@ This action should be configured to respond to the following event triggers:
232232
**Permissions**:
233233

234234
The following permissions are required for this action to operate:
235-
- `contents: write`: to create/edit the signature file
235+
- `contents: write`: to create/edit the Terms of Service acceptance file
236236
- `pull-requests: write`: to comment the pull-request
237237

238238
**Action inputs**:
239239

240-
| Name | Description | Default |
241-
|------------------------------------------|------------------------------------------------------------------------------------|---------|
242-
| `tos-location` | Terms Of Service location (URL) | |
243-
| `pr-number` | pull-request number | |
244-
| `signature-branch` | Git branch where the signature file will be stored | |
245-
| `signature-location` | Signature file location | |
246-
| `pr-comment-tos-acceptance-missing` | pull-request comment added when Terms of Service have not previously been accepted | |
247-
| `pr-comment-tos-acceptance-request` | pull-request comment to accept the Terms of Service | |
248-
| `pr-comment-tos-acceptance-confirmation` | pull-request comment added when Terms of Service are accepted | |
249-
| `white-list` | CSV List of users not required to accept the Terms of Service | |
250-
| `github-token` | Github token | |
240+
| Name | Description | Default |
241+
|-------------------------------------------|------------------------------------------------------------------------------------|---------|
242+
| `tos-location` | Terms Of Service location (URL) | |
243+
| `pr-number` | pull-request number | |
244+
| `tos-acceptance-file-branch` | Git branch where the Terms of Service acceptance file will be stored | |
245+
| `tos-acceptance-file` | Terms of Service acceptance file location | |
246+
| `pr-comment-tos-acceptance-missing` | pull-request comment added when Terms of Service have not previously been accepted | |
247+
| `pr-comment-tos-acceptance-request` | pull-request comment to accept the Terms of Service | |
248+
| `pr-comment-tos-acceptance-confirmation` | pull-request comment added when Terms of Service are accepted | |
249+
| `white-list` | CSV List of users not required to accept the Terms of Service | |
250+
| `github-token` | Github token | |
251251

252252
**Usage**:
253253

‎maven-build-scan/action.yml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ inputs:
2626
pr-comment-tos-acceptance-validation:
2727
description: 'pull-request comment added when Terms of Service are accepted'
2828
default: 'All Contributors have accepted Develocity Terms of Service.'
29-
signature-branch:
30-
description: 'Git branch where the signature file will be stored'
29+
tos-acceptance-file-branch:
30+
description: 'Git branch where the Terms of Service acceptance file will be stored'
3131
default: ${{ github.event.repository.default_branch }}
32-
signature-location:
33-
description: 'Signature file location'
32+
tos-acceptance-file:
33+
description: 'Terms of Service acceptance file location'
3434
default: '.github/develocity-tos.json'
3535
white-list:
3636
description: 'CSV List of users not required to accept the Terms of Service'
@@ -45,24 +45,24 @@ runs:
4545
steps:
4646
- name: Load data
4747
id: load
48-
uses: gradle/github-actions/maven-build-scan/load@v0.1
48+
uses: gradle/github-actions/maven-build-scan/load@v1.0
4949
with:
5050
build-workflow-filename: ${{ inputs.build-workflow-filename }}
5151
pr-comment-tos-acceptance-request: ${{ inputs.pr-comment-tos-acceptance-request }}
5252
- name: Verify Terms of Service acceptance
53-
uses: gradle/github-actions/terms-of-service-acceptance/run@v0.1
53+
uses: gradle/github-actions/terms-of-service-acceptance/run@v1.0
5454
with:
5555
tos-location: ${{ inputs.tos-location }}
5656
pr-number: ${{ steps.load.outputs.pr-number }}
5757
pr-comment-tos-acceptance-missing: ${{ inputs.pr-comment-tos-acceptance-missing }}
5858
pr-comment-tos-acceptance-request: ${{ inputs.pr-comment-tos-acceptance-request }}
5959
pr-comment-tos-acceptance-validation: ${{ inputs.pr-comment-tos-acceptance-validation }}
60-
signature-branch: ${{ inputs.signature-branch }}
61-
signature-location: ${{ inputs.signature-location }}
60+
tos-acceptance-file-branch: ${{ inputs.tos-acceptance-file-branch }}
61+
tos-acceptance-file: ${{ inputs.tos-acceptance-file }}
6262
white-list: ${{ inputs.white-list }}
6363
github-token: ${{ inputs.github-token }}
6464
- name: Publish Maven Build Scans
65-
uses: gradle/github-actions/maven-build-scan/publish@v0.1
65+
uses: gradle/github-actions/maven-build-scan/publish@v1.0
6666
with:
6767
develocity-url: ${{ inputs.develocity-url }}
6868
develocity-access-key: ${{ inputs.develocity-access-key }}

‎maven-build-scan/load/action.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ outputs:
1717
runs:
1818
using: 'composite'
1919
steps:
20-
- name: Check event trigger
20+
- name: Assert event trigger
2121
if: |
2222
(github.event_name != 'issue_comment'
2323
|| (
@@ -27,7 +27,7 @@ runs:
2727
)
2828
&& github.event_name != 'workflow_run'
2929
run: |
30-
echo "Skipping Github event"
30+
echo "Skipping the publication process due to unsupported event trigger"
3131
exit 1
3232
shell: bash
3333
- name: Download Build Metadata after PR Build

‎terms-of-service-acceptance/run/action.yml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ inputs:
1717
pr-comment-tos-acceptance-validation:
1818
description: 'pull-request comment added when Terms of Service are accepted'
1919
required: true
20-
signature-branch:
21-
description: 'Git branch where the signature file will be stored'
20+
tos-acceptance-file-branch:
21+
description: 'Git branch where the Terms of Service acceptance file will be stored'
2222
required: true
23-
signature-location:
24-
description: 'Signature file location'
23+
tos-acceptance-file:
24+
description: 'Terms of Service acceptance file location'
2525
required: true
2626
white-list:
2727
description: 'CSV List of users not required to accept the Terms of Service'
@@ -44,8 +44,8 @@ runs:
4444
custom-notsigned-prcomment: ${{ format(inputs.pr-comment-tos-acceptance-missing, inputs.tos-location )}}
4545
custom-pr-sign-comment: ${{ inputs.pr-comment-tos-acceptance-request }}
4646
custom-allsigned-prcomment: ${{ inputs.pr-comment-tos-acceptance-validation }}
47-
branch: ${{ inputs.signature-branch }}
48-
path-to-signatures: ${{ inputs.signature-location }}
47+
branch: ${{ inputs.tos-acceptance-file-branch }}
48+
path-to-signatures: ${{ inputs.tos-acceptance-file }}
4949
allowlist: ${{ inputs.white-list }}
5050
path-to-document: 'unused'
5151
lock-pullrequest-aftermerge: false

0 commit comments

Comments
 (0)