Bot Updating Package Versions

Jenkinsfile

@@ -16,6 +16,7 @@ pipeline {
     GITHUB_TOKEN=credentials('498b4638-2d02-4ce5-832d-8a57d01d97ab')
     GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0')
     GITLAB_NAMESPACE=credentials('gitlab-namespace-id')
+    DOCKERHUB_TOKEN=credentials('docker-hub-ci-pat')
     EXT_GIT_BRANCH = '2.x'
     EXT_USER = 'linuxserver'
     EXT_REPO = 'Heimdall'
@@ -61,11 +62,16 @@ pipeline {
           env.COMMIT_SHA = sh(
             script: '''git rev-parse HEAD''',
             returnStdout: true).trim()
+          env.GH_DEFAULT_BRANCH = sh(
+            script: '''git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||' ''',
+            returnStdout: true).trim()
           env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT
           env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/'
           env.PULL_REQUEST = env.CHANGE_ID
           env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE .editorconfig ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE/config.yml ./.github/ISSUE_TEMPLATE/issue.bug.yml ./.github/ISSUE_TEMPLATE/issue.feature.yml ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/external_trigger_scheduler.yml ./.github/workflows/greetings.yml ./.github/workflows/package_trigger_scheduler.yml ./.github/workflows/call_issue_pr_tracker.yml ./.github/workflows/call_issues_cron.yml ./.github/workflows/permissions.yml ./.github/workflows/external_trigger.yml ./.github/workflows/package_trigger.yml'
         }
+        sh '''#! /bin/bash
+              echo "The default github branch detected as ${GH_DEFAULT_BRANCH}" '''
         script{
           env.LS_RELEASE_NUMBER = sh(
             script: '''echo ${LS_RELEASE} |sed 's/^.*-ls//g' ''',
@@ -148,7 +154,7 @@ pipeline {
           }
 
           if (env.SEMVER != null) {
-            if (BRANCH_NAME != "master" && BRANCH_NAME != "main") {
+            if (BRANCH_NAME != "${env.GH_DEFAULT_BRANCH}") {
               env.SEMVER = "${env.SEMVER}-${BRANCH_NAME}"
             }
             println("SEMVER: ${env.SEMVER}")
@@ -266,6 +272,14 @@ pipeline {
         }
       }
       steps {
+        withCredentials([
+          [
+            $class: 'UsernamePasswordMultiBinding',
+            credentialsId: '3f9ba4d5-100d-45b0-a3c4-633fd6061207',
+            usernameVariable: 'DOCKERUSER',
+            passwordVariable: 'DOCKERPASS'
+          ]
+        ]) {
           sh '''#! /bin/bash
                 set -e
                 TEMPDIR=$(mktemp -d)
@@ -280,7 +294,8 @@ pipeline {
                   cp ${TEMPDIR}/docker-${CONTAINER_NAME}/Jenkinsfile ${TEMPDIR}/repo/${LS_REPO}/
                   git add Jenkinsfile
                   git commit -m 'Bot Updating Templated Files'
-                git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git --all
+                  git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
+                  git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
                   echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
                   echo "Updating Jenkinsfile"
                   rm -Rf ${TEMPDIR}
@@ -304,7 +319,8 @@ pipeline {
                     git rm "${i}"
                   done
                   git commit -m 'Bot Updating Templated Files'
-                git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git --all
+                  git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
+                  git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
                   echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
                   echo "Deleting old and deprecated templates"
                   rm -Rf ${TEMPDIR}
@@ -333,19 +349,22 @@ pipeline {
                   fi
                   git add readme-vars.yml ${TEMPLATED_FILES}
                   git commit -m 'Bot Updating Templated Files'
-                git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git --all
+                  git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
+                  git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
                   echo "true" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
                 else
                   echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
                 fi
                 mkdir -p ${TEMPDIR}/docs
                 git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation
-              if [[ ("${BRANCH_NAME}" == "master") || ("${BRANCH_NAME}" == "main") ]] && [[ (! -f ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then
+                if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}"  ]] && [[ (! -f ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/docs/docker-documentation/docs/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')") ]]; then
                   cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/docs/docker-documentation/docs/images/
                   cd ${TEMPDIR}/docs/docker-documentation
+                  GH_DOCS_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||')
                   git add docs/images/docker-${CONTAINER_NAME}.md
                   git commit -m 'Bot Updating Documentation'
-                git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git --all
+                  git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH}
+                  git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git ${GH_DOCS_DEFAULT_BRANCH}
                 fi
                 mkdir -p ${TEMPDIR}/unraid
                 git clone https://github.com/linuxserver/docker-templates.git ${TEMPDIR}/unraid/docker-templates
@@ -355,8 +374,9 @@ pipeline {
                 elif [[ -f ${TEMPDIR}/unraid/docker-templates/linuxserver.io/img/${CONTAINER_NAME}-icon.png ]]; then
                   sed -i "s|master/linuxserver.io/img/linuxserver-ls-logo.png|master/linuxserver.io/img/${CONTAINER_NAME}-icon.png|" ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml
                 fi
-              if [[ ("${BRANCH_NAME}" == "master") || ("${BRANCH_NAME}" == "main") ]] && [[ (! -f ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml) || ("$(md5sum ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml | awk '{ print $1 }')") ]]; then
+                if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]] && [[ (! -f ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml) || ("$(md5sum ${TEMPDIR}/unraid/templates/unraid/${CONTAINER_NAME}.xml | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml | awk '{ print $1 }')") ]]; then
                   cd ${TEMPDIR}/unraid/templates/
+                  GH_TEMPLATES_DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch:" | sed 's|.*HEAD branch: ||')
                   if grep -wq "${CONTAINER_NAME}" ${TEMPDIR}/unraid/templates/unraid/ignore.list; then
                     echo "Image is on the ignore list, marking Unraid template as deprecated"
                     cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/${CONTAINER_NAME}.xml ${TEMPDIR}/unraid/templates/unraid/
@@ -368,7 +388,27 @@ pipeline {
                     git add unraid/${CONTAINER_NAME}.xml
                     git commit -m 'Bot Updating Unraid Template'
                   fi
-                git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git --all
+                  git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH}
+                  git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/templates.git ${GH_TEMPLATES_DEFAULT_BRANCH}
+                fi
+                # Stage 4 - Sync Readme to Docker Hub
+                if [[ "${BRANCH_NAME}" == "${GH_DEFAULT_BRANCH}" ]]; then
+                  if [[ $(cat ${TEMPDIR}/docker-${CONTAINER_NAME}/README.md | wc -m) > 25000 ]]; then
+                    echo "Readme is longer than 25,000 characters. Syncing the lite version to Docker Hub"
+                    DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/README.lite"
+                  else
+                    echo "Syncing readme to Docker Hub"
+                    DH_README_SYNC_PATH="${TEMPDIR}/docker-${CONTAINER_NAME}/README.md"
+                  fi
+                  DH_TOKEN=$(curl -d '{"username":"'${DOCKERUSER}'", "password":"'${DOCKERHUB_TOKEN}'"}' -H "Content-Type: application/json" -X POST https://hub.docker.com/v2/users/login | jq -r '.token')
+                  curl -s \
+                    -H "Authorization: JWT ${DH_TOKEN}" \
+                    -H "Content-Type: application/json" \
+                    -X PATCH \
+                    -d "{\\"full_description\\":$(jq -Rsa . ${DH_README_SYNC_PATH})}" \
+                    https://hub.docker.com/v2/repositories/${DOCKERHUB_IMAGE} || :
+                else
+                  echo "Not the default Github branch. Skipping readme sync to Docker Hub."
                 fi
                 rm -Rf ${TEMPDIR}'''
           script{
@@ -378,6 +418,7 @@ pipeline {
           }
         }
       }
+    }
     // Exit the build if the Templated files were just updated
     stage('Template-exit') {
       when {
@@ -568,7 +609,8 @@ pipeline {
                 wait
                 git add package_versions.txt
                 git commit -m 'Bot Updating Package Versions'
-                git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git --all
+                git pull https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
+                git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/${LS_USER}/${LS_REPO}.git development
                 echo "true" > /tmp/packages-${COMMIT_SHA}-${BUILD_NUMBER}
                 echo "Package tag updated, stopping build process"
               else
@@ -864,39 +906,6 @@ EOF
           ) '''
       }
     }
-    // Use helper container to sync the current README on master to the dockerhub endpoint
-    stage('Sync-README') {
-      when {
-        environment name: 'CHANGE_ID', value: ''
-        environment name: 'EXIT_STATUS', value: ''
-      }
-      steps {
-        withCredentials([
-          [
-            $class: 'UsernamePasswordMultiBinding',
-            credentialsId: '3f9ba4d5-100d-45b0-a3c4-633fd6061207',
-            usernameVariable: 'DOCKERUSER',
-            passwordVariable: 'DOCKERPASS'
-          ]
-        ]) {
-          sh '''#! /bin/bash
-                set -e
-                TEMPDIR=$(mktemp -d)
-                docker pull ghcr.io/linuxserver/jenkins-builder:latest
-                docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH="${BRANCH_NAME}" -v ${TEMPDIR}:/ansible/jenkins ghcr.io/linuxserver/jenkins-builder:latest
-                docker pull ghcr.io/linuxserver/readme-sync
-                docker run --rm=true \
-                  -e DOCKERHUB_USERNAME=$DOCKERUSER \
-                  -e DOCKERHUB_PASSWORD=$DOCKERPASS \
-                  -e GIT_REPOSITORY=${LS_USER}/${LS_REPO} \
-                  -e DOCKER_REPOSITORY=${IMAGE} \
-                  -e GIT_BRANCH=master \
-                  -v ${TEMPDIR}/docker-${CONTAINER_NAME}:/mnt \
-                  ghcr.io/linuxserver/readme-sync bash -c 'node sync'
-                rm -Rf ${TEMPDIR} '''
-        }
-      }
-    }
     // If this is a Pull request send the CI link as a comment on it
     stage('Pull Request Comment') {
       when {

README.md

@@ -87,7 +87,6 @@ To help you get started creating a container from this image you can either use
 
 ```yaml
 ---
-version: "2.1"
 services:
   heimdall:
     image: lscr.io/linuxserver/heimdall:development
@@ -201,7 +200,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
 
 ## Updating Info
 
-Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
+Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
 
 Below are the instructions for updating containers:
 
@@ -266,21 +265,6 @@ Below are the instructions for updating containers:
     docker image prune
     ```
 
-### Via Watchtower auto-updater (only use if you don't remember the original parameters)
-
-* Pull the latest image at its tag and replace it with the same env variables in one run:
-
-    ```bash
-    docker run --rm \
-      -v /var/run/docker.sock:/var/run/docker.sock \
-      containrrr/watchtower \
-      --run-once heimdall
-    ```
-
-* You can also remove the old dangling images: `docker image prune`
-
-**warning**: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
-
 ### Image Update Notifications - Diun (Docker Image Update Notifier)
 
 **tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

package_versions.txt

@@ -1,5 +1,5 @@
 NAME                                VERSION                 TYPE         
-Readsfromstdinwithoutleakinginfototheterminalandoutputsbacktostdout  1,                      dotnet        
+Hidden Input                        1, 0, 0, 0              dotnet        
 alpine-baselayout                   3.4.3-r1                apk           
 alpine-baselayout-data              3.4.3-r1                apk           
 alpine-keys                         2.4-r1                  apk           
@@ -19,6 +19,7 @@ busybox-binsh                                                        1.36.1-r5
 ca-certificates                     20230506-r0             apk           
 ca-certificates-bundle              20230506-r0             apk           
 clue/stream-filter                  v1.6.0                  php-composer  
+composer                            2.6.6                   binary        
 composer/pcre                       3.1.0                   php-composer  
 coreutils                           9.3-r1                  apk           
 curl                                8.5.0-r0                apk           
@@ -65,7 +66,7 @@ libattr                                                              2.5.1-r4
 libbsd                              0.11.7-r1               apk           
 libbz2                              1.0.8-r5                apk           
 libc-utils                          0.7.2-r5                apk           
-libcrypto3                                                           3.1.4-r1                apk           
+libcrypto3                          3.1.4-r4                apk           
 libcurl                             8.5.0-r0                apk           
 libedit                             20221030.3.1-r1         apk           
 libexpat                            2.5.0-r1                apk           
@@ -76,7 +77,7 @@ libmd                                                                1.0.4-r2
 libncursesw                         6.4_p20230506-r0        apk           
 libpq                               15.5-r0                 apk           
 libproc2                            4.0.4-r0                apk           
-libssl3                                                              3.1.4-r1                apk           
+libssl3                             3.1.4-r4                apk           
 libstdc++                           12.2.1_git20220924-r10  apk           
 libunistring                        1.1-r1                  apk           
 libuuid                             2.38.1-r8               apk           
@@ -100,7 +101,7 @@ nginx                                                                1.24.0-r7
 nikic/php-parser                    v4.15.2                 php-composer  
 nunomaduro/collision                v5.11.0                 php-composer  
 oniguruma                           6.9.8-r1                apk           
-openssl                                                              3.1.4-r1                apk           
+openssl                             3.1.4-r4                apk           
 opis/closure                        3.6.3                   php-composer  
 pcre                                8.45-r3                 apk           
 pcre2                               10.42-r1                apk           
@@ -179,7 +180,7 @@ sebastian/type                                                       3.2.0
 sebastian/version                   3.0.2                   php-composer  
 shadow                              4.13-r4                 apk           
 skalibs                             2.13.1.1-r1             apk           
-sqlite-libs                                                          3.41.2-r2               apk           
+sqlite-libs                         3.41.2-r3               apk           
 squizlabs/php_codesniffer           3.7.1                   php-composer  
 ssl_client                          1.36.1-r5               apk           
 swiftmailer/swiftmailer             v6.3.0                  php-composer  
@@ -218,7 +219,7 @@ symfony/var-exporter                                                 v5.4.10
 symfony/yaml                        v5.4.14                 php-composer  
 theseer/tokenizer                   1.2.1                   php-composer  
 tijsverkoyen/css-to-inline-styles   2.2.5                   php-composer  
-tzdata                                                               2023c-r1                apk           
+tzdata                              2023d-r0                apk           
 utmps-libs                          0.1.2.1-r1              apk           
 vlucas/phpdotenv                    v5.5.0                  php-composer  
 voku/portable-ascii                 1.6.1                   php-composer