[ ] All new jobs, commands, executors, parameters have descriptions
[ ] Examples have been added for any significant new features
[x] README has been updated, if necessary
Motivation, issues
Fixes #103 - clarifies which type of API token is required, updating the instructions (as the link and page have changed slightly) and the level of user access needed.
Description
Update README to clarify the specific type of API token, update setup instructions, and clarify permissions required.
The CircleCI documentation is scant on information about what permissions are required to query and cancel jobs, but in testing in the UI at least, a user with Viewer access cannot cancel another user's running job, suggesting that Contributor (write access) is required for this orb to operate.
eddiewebb
commented
8 months ago
Checklist
Motivation, issues
Fixes #103 - clarifies which type of API token is required, updating the instructions (as the link and page have changed slightly) and the level of user access needed.
Description
Update README to clarify the specific type of API token, update setup instructions, and clarify permissions required.
The CircleCI documentation is scant on information about what permissions are required to query and cancel jobs, but in testing in the UI at least, a user with Viewer access cannot cancel another user's running job, suggesting that Contributor (write access) is required for this orb to operate.