StatusCheck

StatusCheck is the service used for checking the status of specified website:

• vika.cn
• bbs.vika.cn
• apitable.com
• integration.vika.ltd

Features

• url status check
• scan broken links with a given url

Usage

status-check

1. Create stepci workflow: .github/stepci/url-status-check.yml

version: "1.1"name: Status Checkenv:
host: example.comtests:
example.com:
steps:
- name: GET requesthttp:
url: https://example.commethod: GETcheck:
status: /^20/

You can add a step for checking new sites .

2. Run the workflow by github every minute

3. Get report from github action Status check

 PASS example.com
Tests: 0 failed, 1 passed, 1 total
Steps: 0 failed, 0 skipped, 1 passed, 1 total
Time: 3.832s, estimated 4s
Workflow passed after 3.832s
Give us your feedback on https://step.ci/feedback

Scan broken links

The example below will be executed every monday at 14:00pm, and it will scan all broken links in these two urls (https://example1.com and https://example2.com).

if some broken links are detected, it will create a bug issue and assign it to some team members.

name: 'Broken Links Check'on:
schedule:
- cron: 0 6 * * 1 # every monday at 14:00pm UTC+8:00workflow_dispatch:
jobs:
linkinator:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v3
- name: Scan linksid: scan-linksuses: JustinBeckwith/linkinator-action@v1with:
paths: "https://example1.com, https://example2.com"config: .github/linkinator.config.json
- name: Create new issue as bug reportif: ${{ failure() }}uses: JasonEtco/create-an-issue@v2env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}SUMMARY_LINK: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}with:
filename: .github/broken-links-check-issue-template.md

How to custom your workflow

1. Create workflow yaml file

broken-link.yaml is a real workflow example for you. change the value in jobs.steps[1].with.paths to which url you want to monitor. If more than one url that you want to monitor, please add a comma separated each url.

2. modify the issue template

when a broken link is detected, workflow will create a new bug issue. If you want to modify the issue template, please add a markdown file under ./github/ folder (example file):

---title: Some broken links detectedassignees: kwp-lab, garyli27, Javen-Woolabels: bug---## 🔍 Broken Links check
there are several links are broken.
👉 Please see the [action summary]({{ env.SUMMARY_LINK }})

3. How to ignore the special links we don't want to marked as broken links?

please modify the file ./github/linkinator.config.json, append urls to the value of skip property :

{
"timeout": 5000,
"verbosity": "error",
"retry": 3,
"skip": [
"https://vika.cn/xmlrpc.php",
"https://vika.cn/comments/feed/",
"https://vika.cn/partners/",
"https://apitable.com/comments/feed/",
"https://apitable.com/void\\(0\\);",
"https://beian.miit.gov.cn",
"https://cn.idgcapital.com",
"http://www.tiantu.com.cn/cn/index.aspx",
"https://caicloud.io/",
"https://ruanzu.com/"
]
}

4. Can I run the github workflow manually?

Yes, go to the action page and click the button "Run workflow"

Reference

linkinator-action

stepci