Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Implements GitHub repository url crawler / reporter #1764

Merged
merged 1 commit into from
Sep 16, 2021

Conversation

jpmcb
Copy link
Contributor

@jpmcb jpmcb commented Sep 15, 2021

What this PR does / why we need it

This script uses the gh CLI tool to crawl the tce repo and report any internal links that may exist in issues, PRs, titles, comments, or git history. If found, it prints the corresponding issue and string match to the screen

Usage:

# login to GitHub via CLI first or populate the GITHUB_TOKEN env var before running
$ gh auth login

# start the crawling!
$ ./hack/lint-repo-links.sh

Note: running this script multiple times in a row will result in GitHub rate limiting (which usually expires after an hour).

This script is not intended to be made apart of any CI / CD job but rather, as a one-off maintainer tool to find any possible internal links before MVP release

Details for the Release Notes (PLEASE PROVIDE)

Implemented github crawler & reporter for internal vmware links in repository

Which issue(s) this PR fixes

Related to #1738

Describe testing done for PR

Ran multiple times and redacted any links that needed to be removed

Special notes for your reviewer

N/a

- Used to crawl and report any internal links in the TCE repo

Signed-off-by: John McBride <jmcbride@vmware.com>
@jpmcb jpmcb requested a review from a team as a code owner September 15, 2021 21:47
@github-actions github-actions bot added the owner/release-eng Work executed by VMware release engineering team label Sep 15, 2021
Copy link

@kdaula kdaula left a comment

Choose a reason for hiding this comment

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

lgtm

@jpmcb jpmcb merged commit 4b92669 into vmware-tanzu:main Sep 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla-not-required owner/release-eng Work executed by VMware release engineering team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants