-
Notifications
You must be signed in to change notification settings - Fork 112
Added Broken Links checker for KB Articles #223
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.
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # KB Broken Link Checker | ||
|
|
||
| ### Summary | ||
| Detects **broken HTTP/HTTPS links** inside ServiceNow Knowledge Base articles. | ||
| Returns a list of affected KBs and their problematic URLs. | ||
|
|
||
| ### Inputs | ||
| | Name | Type | Description | Default | | ||
| |------|------|-------------|----------| | ||
| | `kb_query` | String | Encoded query for filtering KB articles | `active=true^published=true` | | ||
| | `max_articles` | Integer | Number of articles to scan | 100 | | ||
| | `timeout_seconds` | Integer | Timeout per request | 5 | | ||
|
|
||
| ### Outputs | ||
| | Name | Type | Description | | ||
| |------|------|-------------| | ||
| | `broken_links` | Array | Array of `{article_sys_id, article_number, article_title, bad_url, http_status}` | | ||
| | `count_broken` | Integer | Total broken links found | | ||
|
|
||
| ### Example Flow Usage | ||
| 1. Drag the **KB Broken Link Checker** action into your flow. | ||
| 2. Set `kb_query = active=true^published=true^category=IT`. | ||
| 3. Run it — outputs will show all invalid links with HTTP status codes. | ||
| 4. You can chain it with an email notification or table insert to track issues. | ||
|
|
||
| ### Test Scenario | ||
| 1. Create a KB article with a bad link like `http://example.invalid/test`. | ||
| 2. Run the action with `max_articles=10`. | ||
| 3. Verify output contains: | ||
| ```json | ||
| { | ||
| "article_number": "KB0010001", | ||
| "bad_url": "http://example.invalid/test", | ||
| "http_status": "Error: ..." | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This repo does not require a readme file. This information should be included in your pull request, or in the action itself in the form of annotations, description text, etc.