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

chore: change access_token to optional #72

Merged
merged 6 commits into from
Sep 30, 2022
Merged

chore: change access_token to optional #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
43268cc
chore: update `action.yml`
MichaelDeBoey Apr 12, 2021
ee123d9
Update index.ts
MichaelDeBoey Apr 14, 2021
3355f0b
Update action.yml
MichaelDeBoey Apr 14, 2021
0ac0008
Update action.yml
MichaelDeBoey May 22, 2021
26b717a
Update README.md
MichaelDeBoey Sep 30, 2022
6b40598
Merge branch 'main' into patch-1
MichaelDeBoey Sep 30, 2022
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
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ jobs:
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.10.0
with:
access_token: ${{ github.token }}
#- name: Run Tests
# uses: actions/setup-node@v1
# run: node test.js
Expand All @@ -48,7 +46,6 @@ jobs:
- uses: styfle/cancel-workflow-action@0.10.0
with:
workflow_id: 479426
access_token: ${{ github.token }}
```

- _Note_: `workflow_id` can be a Workflow ID (number) or Workflow File Name (string)
Expand Down Expand Up @@ -119,7 +116,6 @@ jobs:
- uses: styfle/cancel-workflow-action@0.10.0
with:
all_but_latest: true
access_token: ${{ github.token }}
```

### Advanced: Token Permissions
Expand Down
4 changes: 2 additions & 2 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ inputs:
default: 'false'
access_token:
description: 'Your GitHub Access Token, defaults to: {{ github.token }}'
default: '${{ github.token }}'
required: true
default: ${{ github.token }}
required: false
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has a default value

Copy link
Owner

@styfle styfle Apr 12, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about the required prop in index.ts?

cancel-workflow-action/src/index.ts

Line 33 in cd25b7a

const token = core.getInput('access_token', { required: true });

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@styfle Should it be deleted?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. Are either of these required props causing problems?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They're not causing any problems to me, but I saw it's set to required although it has a default value so that's why I created this PR

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If its not causing problems, lets not change it 🙂

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would argue that it also implies that the docs can be simplified, if this works without passing the default.

all_but_latest:
description: "Cancel all actions but the last one"
required: false
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ async function main() {
}

console.log({ eventName, sha, headSha, branch, owner, repo, GITHUB_RUN_ID });
const token = core.getInput('access_token', { required: true });
const token = core.getInput('access_token');
MichaelDeBoey marked this conversation as resolved.
Show resolved Hide resolved
const workflow_id = core.getInput('workflow_id', { required: false });
const ignore_sha = core.getBooleanInput('ignore_sha', { required: false });
const all_but_latest = core.getBooleanInput('all_but_latest', { required: false });
Expand Down