Skip to content

[Docs] Added Use Case to the Github Action README #3

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[Docs] Added Use Case to the Github Action README #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ecba78
Added use cases
SxMShaDoW Jun 4, 2021
3055769
formatting use cases
SxMShaDoW Jun 4, 2021
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

Execute Instance Scans and get progress and results of runs.

# Use Case
1. Scoped Applications

- If you have a scoped application linked to source control, you can configure Github Actions to trigger when a commit is added from ServiceNow. You would either set it up to just trigger on the scoped application using `appScopeSysIds`or after you have manually run a set of suites on the scoped application, you can utilize the `comboSysId`

2. Triggered remotely through Github APIs

- Another way to utilize this when you don't have code linked to source control, would be to create business rules and REST messages (or flows and rest steps) to trigger the scans. The example that comes to mind is if you want to trigger this without writing code on the target instance. If that is the case, you are going to run into issues around IP listing and having the checks / suite sys_ids known. Although it is possible, it seems overkill for this use case because you could just trigger this through internal ServiceNow APIs

# Usage
## Step 1: Prepare values for setting up your variables for Actions
- credentials (username and password for a service account)
Expand Down