Commit 06c6b0e3 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch '27-use-built-in-mkdocs-lychee' into 'master' 

Resolve "Use built-in mkdocs-lychee"

Closes #27

See merge request to-be-continuous/doc!67
parents 83201146 52cbba33

.gitlab-ci.yml

+2 −9
Original line number Diff line number Diff line
@@ -10,6 +10,8 @@ include: 


variables:

  MKD_SITE_DIR: "public"

  MKD_LYCHEE_ENABLED: "true"

  MKD_LYCHEE_ARGS: "*.md docs/ static/"



  # deploy: landing page (static/), mkdocs build (public/), Angular build (kicker/dist/) and aggregated kicker (kicker-aggregated/)

  S3_DEPLOY_FILES: "static/ public/ kicker-aggregated.json"
@@ -77,15 +79,6 @@ scan-images: 
      when: manual

      allow_failure: true



check-links:

  image:

    name: "registry.hub.docker.com/lycheeverse/lychee:latest"

    entrypoint: [""]

  stage: build

  script:

    - lychee --exclude http://127.0.0.1 --exclude https://my-nonprod-k8s.domain --exclude '/static/intro$' --exclude-path SECURITY.md --exclude-path docs/ref/templates-stages-body.part.html --exclude-path docs/secu/ *.md docs/ static/

  allow_failure: true



# publish on GitLab pages: only on master

pages:

  stage: deploy

docs/intro.md

+1 −1
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ _to be continuous_ proposes a set of GitLab CI templates developed and maintaine 
| [interruptible](https://docs.gitlab.com/ee/ci/yaml/#interruptible) | Every interruptible job implements the `interruptible` feature to allow cancelling the pipeline as soon as a newer one is triggered. |

| [code coverage](https://docs.gitlab.com/ee/ci/yaml/#coverage) | Every build&test job enforces code coverage computing (using the required build tools and options), and integration to GitLab (visible in merge requests and as a [badge](https://docs.gitlab.com/ee/ci/pipelines/settings.html#test-coverage-report-badge)). |

| [JUnit test reports](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsjunit) | Every test job produces - whenever possible - a JUnit report, so that your test reports are automatically integrated to your pipelines and merge requests. |

| [code quality](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) | Every code quality job produces - whenever possible - a Code Climate report, so that your code quality reports are automatically integrated to your pipelines and merge requests. |

| [code quality](https://docs.gitlab.com/ee/ci/testing/code_quality.html) | Every code quality job produces - whenever possible - a Code Climate report, so that your code quality reports are automatically integrated to your pipelines and merge requests. |

| [environments](https://docs.gitlab.com/ee/ci/environments/) | Every deployment job declares the deployed environment to GitLab. They also implement a cleanup job for ephemeral environments, that can be triggered manually and also automatically on branch deletion. |

| [resource_group](https://docs.gitlab.com/ee/ci/yaml/#resource_group) | Every deployment job implements the `resource_group` feature to prevent concurrent jobs deploying at the same time on the same environment. |

lychee.toml

0 → 100644
+16 −0
Original line number Diff line number Diff line 
#############################  Exclusions  ##########################



exclude = [

    # Ignore example URLs

    '.*\.acme.corp\.*',

    'https://my-nonprod-k8s.domain',

    '/static/intro$'

]



# Exclude these filesystem paths from getting checked.

exclude_path = [ "SECURITY.md", "docs/ref/templates-stages-body.part.html", "docs/secu/" ]



# Exclude all private IPs from checking.

# Equivalent to setting `exclude_private`, `exclude_link_local`, and

# `exclude_loopback` to true.

exclude_all_private = true