Commit d371bbf5 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch '19-polinux-mkdocs-image-is-outdated' into 'master' 

Resolve "polinux/mkdocs image is outdated"

Closes #19

See merge request to-be-continuous/mkdocs!52
parents 880208b0 c8f2f6af

README.md

+2 −2
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ The MkDocs template uses some global configuration used throughout all jobs. 


| Input / Variable | Description                            | Default value     |

| ----------------------- | -------------------------------------- | ----------------- |

| `image` / `MKD_IMAGE` | The Docker image used to run MkDocs    | `registry.hub.docker.com/polinux/mkdocs:latest` |

| `image` / `MKD_IMAGE` | The Docker image used to run MkDocs    | `docker.io/squidfunk/mkdocs-material:latest` |

| `workspace-dir` / `MKD_WORKSPACE_DIR` | MkDocs sources directory | `.` |

| `requirements-file` / `MKD_REQUIREMENTS_FILE` | Requirements file. If the file is not found in the repository, requirements are read from the `MKD_REQUIREMENTS` variable | `requirements.txt` |

| `requirements` / `MKD_REQUIREMENTS` | Space separated requirements (ignored if a requirement file is found) | `mkdocs` |
@@ -71,7 +71,7 @@ This job checks links with [lychee](https://github.com/lycheeverse/lychee). It u 
| Input / Variable | Description                                       | Default value     |

| ----------------------- | ------------------------------------------------- | ----------------- |

| `lychee-enabled` / `MKD_LYCHEE_ENABLED` | Set to `true` to enable this job                  | _none_ (disabled) |

| `lychee-image` / `MKD_LYCHEE_IMAGE` | The Docker image used to run [lychee](https://github.com/lycheeverse/lychee) | `registry.hub.docker.com/lycheeverse/lychee:latest` |

| `lychee-image` / `MKD_LYCHEE_IMAGE` | The Docker image used to run [lychee](https://github.com/lycheeverse/lychee) | `docker.io/lycheeverse/lychee:latest` |

| `lychee-args` / `MKD_LYCHEE_ARGS` | [lychee arguments](https://github.com/lycheeverse/lychee#commandline-parameters) to execute | `docs/` |



## Publishing

kicker.json

+2 −2
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 
    {

      "name": "MKD_IMAGE",

      "description": "The Docker image used to run MkDocs",

      "default": "registry.hub.docker.com/polinux/mkdocs:latest"

      "default": "docker.io/squidfunk/mkdocs-material:latest"

    },

    {

      "name": "MKD_BUILD_ARGS",
@@ -63,7 +63,7 @@ 
        {

          "name": "MKD_LYCHEE_IMAGE",

          "description": "The Docker image used to run [lychee](https://github.com/lycheeverse/lychee)",

          "default": "registry.hub.docker.com/lycheeverse/lychee:latest",

          "default": "docker.io/lycheeverse/lychee:latest",

          "advanced": true

        },

        {

templates/gitlab-ci-mkdocs.yml

+5 −3
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ spec: 
  inputs:

    image:

      description: The Docker image used to run MkDocs

      default: registry.hub.docker.com/polinux/mkdocs:latest

      default: docker.io/squidfunk/mkdocs-material:latest

    build-args:

      description: Arguments used by the build job

      default: ''
@@ -46,7 +46,7 @@ spec: 
      default: false

    lychee-image:

      description: The Docker image used to run [lychee](https://github.com/lycheeverse/lychee)

      default: registry.hub.docker.com/lycheeverse/lychee:latest

      default: docker.io/lycheeverse/lychee:latest

    lychee-args:

      description: '[lychee arguments](https://github.com/lycheeverse/lychee#commandline-parameters) to execute'

      default: docs/
@@ -369,7 +369,9 @@ stages: 
  # ENDSCRIPT



.mkdocs-base:

  image: ${MKD_IMAGE}

  image:

    name: $MKD_IMAGE

    entrypoint: [""]

  services:

    - name: "$TBC_TRACKING_IMAGE"

      command: ["--service", "mkdocs", "2.6.0"]