add renovate

README.md

@@ -96,3 +96,10 @@ Lint the `example.yml` playbook:
 ```bash
 ./ansible-lint.sh --offline --parseable example.yml
 ```
+
+List this repository dependencies (and which have newer versions):
+
+```bash
+export GITHUB_COM_TOKEN='YOUR_GITHUB_PERSONAL_TOKEN'
+./renovate.sh
+```

renovate.json5

@@ -0,0 +1,21 @@
+// see https://docs.renovatebot.com/templates/
+// see https://docs.renovatebot.com/modules/manager/
+// see https://docs.renovatebot.com/modules/manager/regex/
+// see https://docs.renovatebot.com/configuration-options/
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "regexManagers": [
+    // default datasources.
+    {
+      "fileMatch": [
+        "^(roles|.github)/.+\\.yml$",
+        "\\.sh$",
+      ],
+      "matchStrings": [
+        "# renovate: datasource=(?<datasource>[^:]+?) depName=(?<depName>.+?)( versioning=(?<versioning>.+?))?( extractVersion=(?<extractVersion>.+?))?( registryUrl=(?<registryUrl>.+?))?\\s.+?[:=]\\s*[\"']?(?<currentValue>.+?)[\"']?\\s"
+      ],
+      "versioningTemplate": "{{#if versioning}}{{{versioning}}}{{else}}semver-coerced{{/if}}",
+      "extractVersionTemplate": "{{#if extractVersion}}{{{extractVersion}}}{{else}}^v?(?<version>.+)${{/if}}"
+    },
+  ]
+}

renovate.sh

@@ -0,0 +1,212 @@
+#!/bin/bash
+set -euo pipefail
+
+# this executes renovate against the local repository.
+# NB this uses a temporary gitea instance because running renovate against a
+#    local directory not (yet?) supported.
+#    see https://github.com/renovatebot/renovate/issues/3609
+
+export RENOVATE_USERNAME='renovate'
+export RENOVATE_NAME='Renovate Bot'
+export RENOVATE_PASSWORD='password'
+gitea_container_name="$(basename "$(dirname "$(realpath "${BASH_SOURCE[0]}")")")-renovate-gitea"
+
+# see https://hub.docker.com/r/gitea/gitea/tags
+# renovate: datasource=docker depName=gitea/gitea
+gitea_version='1.21.6'
+
+# see https://hub.docker.com/r/renovate/renovate/tags
+# renovate: datasource=docker depName=renovate/renovate extractVersion=(?<version>.+)-slim$
+renovate_version='37.210.0'
+
+# clean.
+echo 'Deleting existing Gitea...'
+docker rm --force "$gitea_container_name" >/dev/null 2>&1
+echo 'Deleting existing temporary files...'
+rm -f tmp/renovate-*
+install -d tmp
+
+# start gitea in background.
+# see https://docs.gitea.io/en-us/config-cheat-sheet/
+# see https://github.com/go-gitea/gitea/releases
+# see https://github.com/go-gitea/gitea/blob/v1.21.6/docker/root/etc/s6/gitea/setup
+echo 'Starting Gitea...'
+docker run \
+    --detach \
+    --name "$gitea_container_name" \
+    -v /etc/timezone:/etc/timezone:ro \
+    -v /etc/localtime:/etc/localtime:ro \
+    -e SECRET_KEY=abracadabra \
+    -p 3000 \
+    "gitea/gitea:$gitea_version" \
+    >/dev/null
+gitea_addr="$(docker port "$gitea_container_name" 3000 | head -1)"
+gitea_url="http://$gitea_addr"
+export RENOVATE_ENDPOINT="$gitea_url"
+export GIT_PUSH_REPOSITORY="http://$RENOVATE_USERNAME:$RENOVATE_PASSWORD@$gitea_addr/$RENOVATE_USERNAME/test.git"
+
+# wait for gitea to be ready.
+echo "Waiting for Gitea to be ready at $gitea_url..."
+GITEA_URL="$gitea_url" bash -euc 'while [ -z "$(wget -qO- "$GITEA_URL/api/v1/version" | jq -r ".version | select(.!=null)")" ]; do sleep 5; done'
+
+# create user in gitea.
+echo "Creating Gitea $RENOVATE_USERNAME user..."
+docker exec --user git "$gitea_container_name" gitea admin user create \
+    --admin \
+    --email "$RENOVATE_USERNAME@example.com" \
+    --username "$RENOVATE_USERNAME" \
+    --password "$RENOVATE_PASSWORD"
+curl \
+    --silent \
+    --show-error \
+    --fail-with-body \
+    -u "$RENOVATE_USERNAME:$RENOVATE_PASSWORD" \
+    -X 'PATCH' \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d "{\"full_name\":\"$RENOVATE_NAME\"}" \
+    "$gitea_url/api/v1/user/settings" \
+    | jq \
+    > /dev/null
+
+# create the user personal access token.
+# see https://docs.gitea.io/en-us/api-usage/
+# see https://docs.gitea.io/en-us/oauth2-provider/#scopes
+# see https://try.gitea.io/api/swagger#/user/userCreateToken
+echo "Creating Gitea $RENOVATE_USERNAME user personal access token..."
+curl \
+    --silent \
+    --show-error \
+    --fail-with-body \
+    -u "$RENOVATE_USERNAME:$RENOVATE_PASSWORD" \
+    -X POST \
+    -H "Content-Type: application/json" \
+    -d '{"name": "renovate", "scopes": ["read:user", "write:issue", "write:repository"]}' \
+    "$gitea_url/api/v1/users/$RENOVATE_USERNAME/tokens" \
+    | jq -r .sha1 \
+    >tmp/renovate-gitea-token.txt
+
+# try the token.
+echo "Trying the Gitea $RENOVATE_USERNAME user personal access token..."
+RENOVATE_TOKEN="$(cat tmp/renovate-gitea-token.txt)"
+export RENOVATE_TOKEN
+curl \
+    --silent \
+    --show-error \
+    --fail-with-body \
+    -H "Authorization: token $RENOVATE_TOKEN" \
+    -H 'Accept: application/json' \
+    "$gitea_url/api/v1/version" \
+    | jq \
+    > /dev/null
+
+# create remote repository in gitea.
+echo "Creating Gitea $RENOVATE_USERNAME test repository..."
+curl \
+    --silent \
+    --show-error \
+    --fail-with-body \
+    -u "$RENOVATE_USERNAME:$RENOVATE_PASSWORD" \
+    -X POST \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{"name": "test"}' \
+    "$gitea_url/api/v1/user/repos" \
+    | jq \
+    > /dev/null
+
+# push the code to local gitea repository.
+# NB running renovate locally is not yet supported.
+#    see https://github.com/renovatebot/renovate/issues/3609
+echo "Pushing local repository to Gitea $RENOVATE_USERNAME test repository..."
+git push --force "$GIT_PUSH_REPOSITORY"
+
+# see https://docs.renovatebot.com/modules/platform/gitea/
+# see https://docs.renovatebot.com/self-hosted-configuration/#dryrun
+# see https://github.com/renovatebot/renovate/blob/main/docs/usage/examples/self-hosting.md
+# see https://github.com/renovatebot/renovate/tree/main/lib/modules/datasource
+# see https://github.com/renovatebot/renovate/tree/main/lib/modules/versioning
+RENOVATE_TOKEN="$(cat tmp/renovate-gitea-token.txt)"
+export RENOVATE_TOKEN
+# NB these can also be passed as raw positional arguments to docker run.
+export RENOVATE_REPOSITORIES="$RENOVATE_USERNAME/test"
+# see https://docs.github.com/en/rest/rate-limit#get-rate-limit-status-for-the-authenticated-user
+# see https://github.com/settings/tokens
+# NB this is only used for authentication. the token should not have any scope enabled.
+#export GITHUB_COM_TOKEN='TODO-YOUR-TOKEN'
+# let renovate create all the required pull requests.
+# see https://docs.renovatebot.com/configuration-options/#prhourlylimit
+# see https://docs.renovatebot.com/configuration-options/#prconcurrentlimit
+export RENOVATE_PR_HOURLY_LIMIT='0'
+export RENOVATE_PR_CONCURRENT_LIMIT='0'
+echo 'Running renovate...'
+# NB use --dry-run=lookup for not modifying the repository (e.g. for not
+#    creating pull requests).
+docker run \
+  --rm \
+  --tty \
+  --interactive \
+  --net host \
+  --env GITHUB_COM_TOKEN \
+  --env RENOVATE_ENDPOINT \
+  --env RENOVATE_TOKEN \
+  --env RENOVATE_REPOSITORIES \
+  --env RENOVATE_PR_HOURLY_LIMIT \
+  --env RENOVATE_PR_CONCURRENT_LIMIT \
+  --env LOG_LEVEL=debug \
+  --env LOG_FORMAT=json \
+  "renovate/renovate:$renovate_version-slim" \
+  --platform=gitea \
+  --git-url=endpoint \
+  >tmp/renovate-log.json
+
+echo 'Getting results...'
+# extract the errors.
+jq 'select(.err)' tmp/renovate-log.json >tmp/renovate-errors.json
+# extract the result from the renovate log.
+jq 'select(.msg == "packageFiles with updates") | .config' tmp/renovate-log.json >tmp/renovate-result.json
+# extract all the dependencies.
+jq 'to_entries[].value[] | {packageFile,dep:.deps[]}' tmp/renovate-result.json >tmp/renovate-dependencies.json
+# extract the dependencies that have updates.
+jq 'select((.dep.updates | length) > 0)' tmp/renovate-dependencies.json >tmp/renovate-dependencies-updates.json
+
+# helpers.
+function show-title {
+    echo
+    echo '#'
+    echo "# $1"
+    echo '#'
+    echo
+}
+
+# show errors.
+if [ "$(jq --slurp length tmp/renovate-errors.json)" -ne '0' ]; then
+    show-title errors
+    jq . tmp/renovate-errors.json
+fi
+
+# show dependencies.
+function show-dependencies {
+    show-title "$1"
+    (
+        printf 'packageFile\tdatasource\tdepName\tcurrentValue\tnewVersions\tskipReason\twarnings\n'
+        jq \
+            -r \
+            '[
+                .packageFile,
+                .dep.datasource,
+                .dep.depName,
+                .dep.currentValue,
+                (.dep | select(.updates) | .updates | map(.newVersion) | join(" | ")),
+                .dep.skipReason,
+                (.dep | select(.warnings) | .warnings | map(.message) | join(" | "))
+            ] | @tsv' \
+            "$2" \
+            | sort
+    ) | column -t -s "$(printf \\t)"
+}
+show-dependencies 'Dependencies' tmp/renovate-dependencies.json
+show-dependencies 'Dependencies Updates' tmp/renovate-dependencies-updates.json
+
+# show the gitea project.
+show-title "See PRs at $gitea_url/$RENOVATE_USERNAME/test/pulls (you can login as $RENOVATE_USERNAME:$RENOVATE_PASSWORD)"