Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

ci: more thorough link checking #2956

Merged
merged 1 commit into from
Apr 3, 2020
Merged

Conversation

dholbach
Copy link
Member

@dholbach dholbach commented Apr 1, 2020

I split this out of #2948. So this PR can be about link checking only.

  • .github/workflows/markdown-link-check-config.json has some patterns we exclude while checking the markdown files in the top-level directories (company websites on README.md and billions of GH issues in CHANGELOG.md in particular)
  • once Add max depth gaurav-nelson/github-action-markdown-link-check#26 is merged, we can move back to the official GH Action

Overall it gets more complicated. What I'm doing here is:

  • check generated docs in site using the action which uses liche - this works as well as it did before
  • use the new markdown action to check the docs in ./ and ./internal/docs - unfortunately you can't pass two paths easily and I needed to mess with the find incantation in the action itself, thanks @hiddeco for the psychological support.

@dholbach dholbach added help wanted docs Issue or PR relates to documentation labels Apr 1, 2020
This was referenced Apr 1, 2020
@dholbach dholbach force-pushed the improve-link-checking branch 2 times, most recently from dc94541 to 51fafcd Compare April 1, 2020 10:49
@dholbach dholbach marked this pull request as ready for review April 1, 2020 10:50
@dholbach dholbach changed the title attempt better link checking more thorough link checking Apr 1, 2020
@dholbach dholbach requested review from hiddeco and stefanprodan April 1, 2020 10:51
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 1, 2020
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 1, 2020
@dholbach dholbach requested a review from hiddeco April 1, 2020 13:04
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 1, 2020
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

	- .github/workflows/markdown-link-check-config.json has some
	  patterns we exlude while checking the markdown files in the
	  top-level directories (company websites on README.md and
	  billions of GH issues in CHANGELOG.md in particular)
	- once gaurav-nelson/github-action-markdown-link-check#26
	  is merged, we can move back to the official GH Action
@dholbach dholbach force-pushed the improve-link-checking branch from 22e0ee4 to ab279ad Compare April 3, 2020 07:35
@stefanprodan stefanprodan changed the title more thorough link checking ci: more thorough link checking Apr 3, 2020
@stefanprodan stefanprodan merged commit 7210b86 into master Apr 3, 2020
@stefanprodan stefanprodan deleted the improve-link-checking branch April 3, 2020 07:59
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 3, 2020
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 6, 2020
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 7, 2020
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 11, 2020
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 27, 2020
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 28, 2020
	move back to upstream GH action
	update pymdown-extensions
	update to mkdocs-material 5: https://squidfunk.github.io/mkdocs-material/releases/5/#how-to-upgrade
	fix links
	follow fluxcd/flux#3006
	parallelise checking
dholbach pushed a commit to fluxcd/helm-operator that referenced this pull request Apr 29, 2020
	move back to upstream GH action
	update pymdown-extensions
	update to mkdocs-material 5: https://squidfunk.github.io/mkdocs-material/releases/5/#how-to-upgrade
	fix links
	follow fluxcd/flux#3006
	parallelise checking
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Issue or PR relates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants