-
Notifications
You must be signed in to change notification settings - Fork 884
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Lychee Link Checker into OSD (#938)
1. Fix broken links in OSD 2. Generate lycheeexcude list to filter out false negative warnings from test files or external links 3. Add TODO items for internal unavaiable links 4. Integrate with doc link service change. 5. Standardize all opensearch url with `https://opensearch.org/` and add unavilable urls into noDocument list Signed-off-by: Zuocheng Ding <zding817@gmail.com>
- Loading branch information
1 parent
b8c5453
commit 8c11eff
Showing
187 changed files
with
805 additions
and
320 deletions.
There are no files selected for viewing
This file contains 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,31 @@ | ||
| # Copyright OpenSearch Contributors | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| name: Link Checker | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| pull_request: | ||
| branches: [ main ] | ||
|
|
||
| jobs: | ||
| linkchecker: | ||
|
|
||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Load Excludes | ||
| run: | | ||
| LYCHEE_EXCLUDE=$(sed -e :a -e 'N;s/\n/ --exclude /;ta' .lycheeexclude) | ||
| echo "LYCHEE_EXCLUDE=$LYCHEE_EXCLUDE" >> $GITHUB_ENV | ||
| - name: Lychee Link Checker | ||
| id: lychee | ||
| uses: lycheeverse/lychee-action@master | ||
| with: | ||
| args: --accept=200,403,429 --exclude ${{ env.LYCHEE_EXCLUDE }} --exclude-mail "**/*.html" "**/*.md" "**/*.txt" "**/*.json" "**/*.js" "**/*.ts" "**/*.tsx" | ||
| env: | ||
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} | ||
| - name: Fail if there were link errors | ||
| run: exit ${{ steps.lychee.outputs.exit_code }} |
This file contains 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,114 @@ | ||
| # Copyright OpenSearch Contributors | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| # Local or predefined end points | ||
| http://localhost | ||
| https://localhost | ||
| http://127.0.0.1/ | ||
| https://127.0.0.1/ | ||
| http://127.0.0.1:10002/bar | ||
| http://127.0.0.1:10002/ | ||
| http://opensearch | ||
| https://opensearch | ||
| https://opensearch-dashboards | ||
| http://opensearch-dashboards | ||
| https://opensearch.internal.org/ | ||
| https://maps.search-services.aws.a2z.com/ | ||
| https://tiles.maps.search-services.aws.a2z.com/ | ||
| https://telemetry.opensearch.org/ | ||
| https://telemetry-staging.opensearch.org/ | ||
| https://api.github.com/repos/opensearch-project/OpenSearch-Dashboards/ | ||
| file:///* | ||
| git://* | ||
|
|
||
| # Dummy urls in tests | ||
| http://domain. | ||
| http://www.domain. | ||
| http://somehost | ||
| https://somehost | ||
| http://some.host | ||
| https://some-host.com/ | ||
| https://other.some-host.com/ | ||
| http://test:user@somehost/ | ||
| https://some.another.host/ | ||
| http://noone.nowhere.none/ | ||
| http://bar | ||
| http://foo | ||
| http://test.com/ | ||
| https://files.foobar/ | ||
| https://tiles.foobar/ | ||
| https://1.1.1.1:9200/ | ||
| http://192.168.1.1:1234/ | ||
| http://9.8.7.6/ | ||
| http://1.2.3.4/ | ||
| http://8.8.8.8/ | ||
| https://path.to/ | ||
| https://example.com/ | ||
| http://example.com/ | ||
| https://example.org/ | ||
| http://some-url/ | ||
| http://buildurl/ | ||
| https://dryrun/ | ||
| https://url/ | ||
| http://url/ | ||
| http://notfound.svg/ | ||
| https://validurl/ | ||
| https://myopensearch-dashboardsdomain.com | ||
| http://myopensearch-dashboardsdomain.com | ||
| https://other-opensearch-dashboards.external:8080/ | ||
| http://myotherdomain.com:5601/ | ||
| http://myopensearch-dashboardsdomain.com:5601/ | ||
| https://your-cdn-host.com/ | ||
| http://not-your-opensearch-dashboards.com/ | ||
| http://www.mysite.com/ | ||
| http://myserver.mydomain.com:5601/ | ||
| https://myexternaldep.com/ | ||
| http://notlocalhost/ | ||
| http://site.com/ | ||
| http://node-b/ | ||
| http://node-a:9200/ | ||
| https://node-c/ | ||
| https://elsewhere | ||
| https://opensearch:changeme@example.com:9200 | ||
| http://test:user@somehost/ | ||
| https://mycloudinstance:9200/ | ||
| https://dev-url.co/ | ||
| https://extenal.org/_search | ||
| http://plugins.example.com/ | ||
| https://build-url/ | ||
| http://test.com/ | ||
| https://path.to/ | ||
| http://site.com/ | ||
| http://not-your-opensearch-dashboards.com/ | ||
| http://evil.com/ | ||
| https://opensearch.org/cool/path | ||
| https://opensearch.org/redirect | ||
| http://www.opensearch.org/painlessDocs | ||
| https://opensearch.org/subscriptions | ||
| https://www.hostedgraphite.com/ | ||
|
|
||
| # External urls | ||
| https://www.zeek.org/ | ||
| http://google.com/ | ||
| https://api.worldbank.org/ | ||
| https://vega.github.io/ | ||
| http://twitter.com/ | ||
| https://twitter.com/ | ||
| https://storage.googleapis.com/ | ||
| http://tools.ietf.org/ | ||
| https://github.com/ | ||
| http://github.com/ | ||
| http://jsperf | ||
| https://jsperf | ||
| https://gist.githubusercontent.com/ | ||
| https://nodejs.org/ | ||
| https://www.npmjs.com/ | ||
| https://microsoft.github.io/ | ||
| http://api.worldbank.org/ | ||
| https://f1542b814f674090afd914960583265f.apm.us-central1.gcp.cloud.es.io/ | ||
| http://www.matthewcopeland.me/ | ||
| http://threedubmedia.googlecode.com/* | ||
| https://developer.mozilla.org/ | ||
| https://a.tile.openstreetmap.org/ | ||
| http://www.creedthoughts.gov | ||
| https://media-for-the-masses.theacademyofperformingartsandscience.org/ |
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
2 changes: 1 addition & 1 deletion
2
packages/osd-spec-to-console/test/fixtures/cluster_health_spec.json
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.