Bot Updating Package Versions

Jenkinsfile

@@ -16,7 +16,6 @@ pipeline {
     GITHUB_TOKEN=credentials('498b4638-2d02-4ce5-832d-8a57d01d97ab')
     GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0')
     GITLAB_NAMESPACE=credentials('gitlab-namespace-id')
-    SCARF_TOKEN=credentials('scarf_api_key')
     EXT_GIT_BRANCH = '2.x'
     EXT_USER = 'linuxserver'
     EXT_REPO = 'Heimdall'
@@ -339,12 +338,12 @@ pipeline {
               else
                 echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
               fi
-              mkdir -p ${TEMPDIR}/gitbook
+              mkdir -p ${TEMPDIR}/docs
-              git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/gitbook/docker-documentation
+              git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/docs/docker-documentation
-              if [[ ("${BRANCH_NAME}" == "master") || ("${BRANCH_NAME}" == "main") ]] && [[ (! -f ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md) || ("$(md5sum ${TEMPDIR}/gitbook/docker-documentation/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}" == "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
-                cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/gitbook/docker-documentation/images/
+                cp ${TEMPDIR}/docker-${CONTAINER_NAME}/.jenkins-external/docker-${CONTAINER_NAME}.md ${TEMPDIR}/docs/docker-documentation/docs/images/
-                cd ${TEMPDIR}/gitbook/docker-documentation/
+                cd ${TEMPDIR}/docs/docker-documentation
-                git add images/docker-${CONTAINER_NAME}.md
+                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
               fi
@@ -435,35 +434,6 @@ pipeline {
              "visibility":"public"}' '''
       } 
     }
-    /* #######################
-           Scarf.sh package registry
-       ####################### */
-    // Add package to Scarf.sh and set permissions
-    stage("Scarf.sh package registry"){
-      when {
-        branch "development"
-        environment name: 'EXIT_STATUS', value: ''
-      }
-      steps{
-        sh '''#! /bin/bash
-              PACKAGE_UUID=$(curl -X GET -H "Authorization: Bearer ${SCARF_TOKEN}" https://scarf.sh/api/v1/organizations/linuxserver-ci/packages | jq -r '.[] | select(.name=="linuxserver/heimdall") | .uuid' || :)
-              if [ -z "${PACKAGE_UUID}" ]; then
-                echo "Adding package to Scarf.sh"
-                curl -sX POST https://scarf.sh/api/v1/organizations/linuxserver-ci/packages \
-                  -H "Authorization: Bearer ${SCARF_TOKEN}" \
-                  -H "Content-Type: application/json" \
-                  -d '{"name":"linuxserver/heimdall",\
-                       "shortDescription":"example description",\
-                       "libraryType":"docker",\
-                       "website":"https://github.com/linuxserver/docker-heimdall",\
-                       "backendUrl":"https://ghcr.io/linuxserver/heimdall",\
-                       "publicUrl":"https://lscr.io/linuxserver/heimdall"}' || :
-              else
-                echo "Package already exists on Scarf.sh"
-              fi
-           '''
-      } 
-    }
     /* ###############
        Build Container
        ############### */
@@ -859,6 +829,41 @@ pipeline {
               curl -H "Authorization: token ${GITHUB_TOKEN}" -X POST https://api.github.com/repos/${LS_USER}/${LS_REPO}/releases -d @releasebody.json.done'''
       }
     }
+    // Add protection to the release branch
+    stage('Github-Release-Branch-Protection') {
+      when {
+        branch "development"
+        environment name: 'CHANGE_ID', value: ''
+        environment name: 'EXIT_STATUS', value: ''
+      }
+      steps {
+        echo "Setting up protection for release branch development"
+        sh '''#! /bin/bash
+          curl -H "Authorization: token ${GITHUB_TOKEN}" -X PUT https://api.github.com/repos/${LS_USER}/${LS_REPO}/branches/development/protection \
+          -d $(jq -c .  << EOF
+            {
+              "required_status_checks": null,
+              "enforce_admins": false,
+              "required_pull_request_reviews": {
+                "dismiss_stale_reviews": false,
+                "require_code_owner_reviews": false,
+                "require_last_push_approval": false,
+                "required_approving_review_count": 1
+              },
+              "restrictions": null,
+              "required_linear_history": false,
+              "allow_force_pushes": false,
+              "allow_deletions": false,
+              "block_creations": false,
+              "required_conversation_resolution": true,
+              "lock_branch": false,
+              "allow_fork_syncing": false,
+              "required_signatures": false
+            }
+EOF
+          ) '''
+      }
+    }
     // Use helper container to sync the current README on master to the dockerhub endpoint
     stage('Sync-README') {
       when {

README.md

@@ -1,6 +1,5 @@
-<!-- DO NOT EDIT THIS FILE MANUALLY  -->
+<!-- DO NOT EDIT THIS FILE MANUALLY -->
-<!-- Please read the https://github.com/linuxserver/docker-heimdall/blob/development/.github/CONTRIBUTING.md -->
+<!-- Please read https://github.com/linuxserver/docker-heimdall/blob/development/.github/CONTRIBUTING.md -->
-
 [![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
 
 [![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
@@ -70,6 +69,7 @@ This image provides various versions that are available via tags. Please read th
 | :----: | :----: |--- |
 | latest | ✅ | Stable Heimdall releases. |
 | development | ✅ | Latest commit from the github 2.x branch. |
+
 ## Application Setup
 
 Access the web gui at http://SERVERIP:PORT
@@ -81,7 +81,7 @@ This image now supports password protection through htpasswd. Run the following
 
 ## Usage
 
-Here are some example snippets to help you get started creating a container.
+To help you get started creating a container from this image you can either use docker-compose or the docker cli.
 
 ### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
 
@@ -117,12 +117,11 @@ docker run -d \
   -v /path/to/appdata/config:/config \
   --restart unless-stopped \
   lscr.io/linuxserver/heimdall:development
-
 ```
 
 ## Parameters
 
-Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
+Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
 
 | Parameter | Function |
 | :----: | --- |
@@ -140,10 +139,10 @@ You can set any environment variable from a file by using a special prepend `FIL
 As an example:
 
 ```bash
--e FILE__PASSWORD=/run/secrets/mysecretpassword
+-e FILE__MYVAR=/run/secrets/mysecretvariable
 ```
 
-Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
+Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
 
 ## Umask for running applications
 
@@ -152,15 +151,20 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
 
 ## User / Group Identifiers
 
-When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
+When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
 
 Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
 
-In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
+In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
 
 ```bash
-  $ id username
+id your_user
-    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
+```
+
+Example output:
+
+```text
+uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 ```
 
 ## Docker Mods
@@ -171,12 +175,29 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
 
 ## Support Info
 
-* Shell access whilst the container is running: `docker exec -it heimdall /bin/bash`
+* Shell access whilst the container is running:
-* To monitor the logs of the container in realtime: `docker logs -f heimdall`
+
-* container version number
+    ```bash
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall`
+    docker exec -it heimdall /bin/bash
-* image version number
+    ```
-  * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall:development`
+
+* To monitor the logs of the container in realtime:
+
+    ```bash
+    docker logs -f heimdall
+    ```
+
+* Container version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall
+    ```
+
+* Image version number:
+
+    ```bash
+    docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall:development
+    ```
 
 ## Updating Info
 
@@ -186,38 +207,83 @@ Below are the instructions for updating containers:
 
 ### Via Docker Compose
 
-* Update all images: `docker-compose pull`
+* Update images:
-  * or update a single image: `docker-compose pull heimdall`
+    * All images:
-* Let compose update all containers as necessary: `docker-compose up -d`
+
-  * or update a single container: `docker-compose up -d heimdall`
+        ```bash
-* You can also remove the old dangling images: `docker image prune`
+        docker-compose pull
+        ```
+
+    * Single image:
+
+        ```bash
+        docker-compose pull heimdall
+        ```
+
+* Update containers:
+    * All containers:
+
+        ```bash
+        docker-compose up -d
+        ```
+
+    * Single container:
+
+        ```bash
+        docker-compose up -d heimdall
+        ```
+
+* You can also remove the old dangling images:
+
+    ```bash
+    docker image prune
+    ```
 
 ### Via Docker Run
 
-* Update the image: `docker pull lscr.io/linuxserver/heimdall:development`
+* Update the image:
-* Stop the running container: `docker stop heimdall`
+
-* Delete the container: `docker rm heimdall`
+    ```bash
+    docker pull lscr.io/linuxserver/heimdall:development
+    ```
+
+* Stop the running container:
+
+    ```bash
+    docker stop heimdall
+    ```
+
+* Delete the container:
+
+    ```bash
+    docker rm heimdall
+    ```
+
 * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
-* You can also remove the old dangling images: `docker image prune`
+* You can also remove the old dangling images:
+
+    ```bash
+    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
+    ```bash
-  docker run --rm \
+    docker run --rm \
-  -v /var/run/docker.sock:/var/run/docker.sock \
+      -v /var/run/docker.sock:/var/run/docker.sock \
-  containrrr/watchtower \
+      containrrr/watchtower \
-  --run-once heimdall
+      --run-once heimdall
-  ```
+    ```
 
 * You can also remove the old dangling images: `docker image prune`
 
-**Note:** 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).
+**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)
 
-* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
+**tip**: We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
 
 ## Building locally
 

package_versions.txt

@@ -3,8 +3,8 @@ Reads from stdin without leaking info to the terminal and outputs back to stdout
 alpine-baselayout                                                                 3.4.3-r1                apk           
 alpine-baselayout-data                                                            3.4.3-r1                apk           
 alpine-keys                                                                       2.4-r1                  apk           
-alpine-release                                                                    3.18.2-r0               apk           
+alpine-release                                                                    3.18.4-r0               apk           
-apache2-utils                                                                     2.4.57-r3               apk           
+apache2-utils                                                                     2.4.58-r0               apk           
 apk-tools                                                                         2.14.0-r2               apk           
 apr                                                                               1.7.4-r0                apk           
 apr-util                                                                          1.6.3-r1                apk           
@@ -14,15 +14,14 @@ barryvdh/reflection-docblock
 bash                                                                              5.2.15-r5               apk           
 brick/math                                                                        0.9.3                   php-composer  
 brotli-libs                                                                       1.0.9-r14               apk           
-busybox                                                                           1.36.1                  binary        
+busybox                                                                           1.36.1-r4               apk           
-busybox                                                                           1.36.1-r2               apk           
+busybox-binsh                                                                     1.36.1-r4               apk           
-busybox-binsh                                                                     1.36.1-r2               apk           
 ca-certificates                                                                   20230506-r0             apk           
 ca-certificates-bundle                                                            20230506-r0             apk           
 clue/stream-filter                                                                v1.6.0                  php-composer  
 composer/pcre                                                                     3.1.0                   php-composer  
 coreutils                                                                         9.3-r1                  apk           
-curl                                                                              8.2.1-r0                apk           
+curl                                                                              8.4.0-r0                apk           
 dflydev/dot-access-data                                                           v3.0.2                  php-composer  
 doctrine/cache                                                                    2.2.0                   php-composer  
 doctrine/dbal                                                                     3.5.1                   php-composer  
@@ -66,8 +65,8 @@ libattr
 libbsd                                                                            0.11.7-r1               apk           
 libbz2                                                                            1.0.8-r5                apk           
 libc-utils                                                                        0.7.2-r5                apk           
-libcrypto3                                                                        3.1.1-r3                apk           
+libcrypto3                                                                        3.1.4-r0                apk           
-libcurl                                                                           8.2.1-r0                apk           
+libcurl                                                                           8.4.0-r0                apk           
 libedit                                                                           20221030.3.1-r1         apk           
 libexpat                                                                          2.5.0-r1                apk           
 libgcc                                                                            12.2.1_git20220924-r10  apk           
@@ -75,9 +74,9 @@ libidn2
 libintl                                                                           0.21.1-r7               apk           
 libmd                                                                             1.0.4-r2                apk           
 libncursesw                                                                       6.4_p20230506-r0        apk           
-libpq                                                                             15.3-r0                 apk           
+libpq                                                                             15.4-r0                 apk           
-libproc2                                                                          4.0.3-r1                apk           
+libproc2                                                                          4.0.4-r0                apk           
-libssl3                                                                           3.1.1-r3                apk           
+libssl3                                                                           3.1.4-r0                apk           
 libstdc++                                                                         12.2.1_git20220924-r10  apk           
 libunistring                                                                      1.1-r1                  apk           
 libuuid                                                                           2.38.1-r8               apk           
@@ -87,8 +86,8 @@ linux-pam
 logrotate                                                                         3.21.0-r1               apk           
 mockery/mockery                                                                   1.5.1                   php-composer  
 monolog/monolog                                                                   2.8.0                   php-composer  
-musl                                                                              1.2.4-r1                apk           
+musl                                                                              1.2.4-r2                apk           
-musl-utils                                                                        1.2.4-r1                apk           
+musl-utils                                                                        1.2.4-r2                apk           
 myclabs/deep-copy                                                                 1.11.0                  php-composer  
 nano                                                                              7.2-r1                  apk           
 ncurses-terminfo-base                                                             6.4_p20230506-r0        apk           
@@ -96,19 +95,17 @@ nesbot/carbon
 netcat-openbsd                                                                    1.219-r1                apk           
 nette/schema                                                                      v1.2.3                  php-composer  
 nette/utils                                                                       v3.2.8                  php-composer  
-nghttp2-libs                                                                      1.55.1-r0               apk           
+nghttp2-libs                                                                      1.57.0-r0               apk           
-nginx                                                                             1.24.0-r6               apk           
+nginx                                                                             1.24.0-r7               apk           
 nikic/php-parser                                                                  v4.15.2                 php-composer  
 nunomaduro/collision                                                              v5.11.0                 php-composer  
 oniguruma                                                                         6.9.8-r1                apk           
-openssl                                                                           3.1.1-r3                apk           
+openssl                                                                           3.1.4-r0                apk           
 opis/closure                                                                      3.6.3                   php-composer  
 pcre                                                                              8.45-r3                 apk           
 pcre2                                                                             10.42-r1                apk           
 phar-io/manifest                                                                  2.0.3                   php-composer  
 phar-io/version                                                                   3.2.1                   php-composer  
-php-cli                                                                           8.2.8                   binary        
-php-fpm                                                                           8.2.8                   binary        
 php-http/cache-plugin                                                             1.7.5                   php-composer  
 php-http/client-common                                                            2.6.0                   php-composer  
 php-http/discovery                                                                1.14.3                  php-composer  
@@ -117,28 +114,28 @@ php-http/message
 php-http/message-factory                                                          v1.0.2                  php-composer  
 php-http/multipart-stream-builder                                                 1.2.0                   php-composer  
 php-http/promise                                                                  1.1.0                   php-composer  
-php82                                                                             8.2.8-r0                apk           
+php82                                                                             8.2.10-r0               apk           
-php82-common                                                                      8.2.8-r0                apk           
+php82-common                                                                      8.2.10-r0               apk           
-php82-ctype                                                                       8.2.8-r0                apk           
+php82-ctype                                                                       8.2.10-r0               apk           
-php82-curl                                                                        8.2.8-r0                apk           
+php82-curl                                                                        8.2.10-r0               apk           
-php82-fileinfo                                                                    8.2.8-r0                apk           
+php82-fileinfo                                                                    8.2.10-r0               apk           
-php82-fpm                                                                         8.2.8-r0                apk           
+php82-fpm                                                                         8.2.10-r0               apk           
-php82-iconv                                                                       8.2.8-r0                apk           
+php82-iconv                                                                       8.2.10-r0               apk           
-php82-intl                                                                        8.2.8-r0                apk           
+php82-intl                                                                        8.2.10-r0               apk           
-php82-mbstring                                                                    8.2.8-r0                apk           
+php82-mbstring                                                                    8.2.10-r0               apk           
-php82-mysqlnd                                                                     8.2.8-r0                apk           
+php82-mysqlnd                                                                     8.2.10-r0               apk           
-php82-openssl                                                                     8.2.8-r0                apk           
+php82-openssl                                                                     8.2.10-r0               apk           
-php82-pdo                                                                         8.2.8-r0                apk           
+php82-pdo                                                                         8.2.10-r0               apk           
-php82-pdo_mysql                                                                   8.2.8-r0                apk           
+php82-pdo_mysql                                                                   8.2.10-r0               apk           
-php82-pdo_pgsql                                                                   8.2.8-r0                apk           
+php82-pdo_pgsql                                                                   8.2.10-r0               apk           
-php82-pdo_sqlite                                                                  8.2.8-r0                apk           
+php82-pdo_sqlite                                                                  8.2.10-r0               apk           
-php82-phar                                                                        8.2.8-r0                apk           
+php82-phar                                                                        8.2.10-r0               apk           
-php82-session                                                                     8.2.8-r0                apk           
+php82-session                                                                     8.2.10-r0               apk           
-php82-simplexml                                                                   8.2.8-r0                apk           
+php82-simplexml                                                                   8.2.10-r0               apk           
-php82-tokenizer                                                                   8.2.8-r0                apk           
+php82-tokenizer                                                                   8.2.10-r0               apk           
-php82-xml                                                                         8.2.8-r0                apk           
+php82-xml                                                                         8.2.10-r0               apk           
-php82-xmlwriter                                                                   8.2.8-r0                apk           
+php82-xmlwriter                                                                   8.2.10-r0               apk           
-php82-zip                                                                         8.2.8-r0                apk           
+php82-zip                                                                         8.2.10-r0               apk           
 phpdocumentor/reflection-common                                                   2.2.0                   php-composer  
 phpdocumentor/type-resolver                                                       1.6.2                   php-composer  
 phpoption/phpoption                                                               1.9.0                   php-composer  
@@ -149,7 +146,7 @@ phpunit/php-text-template
 phpunit/php-timer                                                                 5.0.3                   php-composer  
 phpunit/phpunit                                                                   9.5.26                  php-composer  
 popt                                                                              1.19-r2                 apk           
-procps-ng                                                                         4.0.3-r1                apk           
+procps-ng                                                                         4.0.4-r0                apk           
 psr/cache                                                                         1.0.1                   php-composer  
 psr/container                                                                     1.1.2                   php-composer  
 psr/event-dispatcher                                                              1.0.0                   php-composer  
@@ -184,7 +181,7 @@ shadow
 skalibs                                                                           2.13.1.1-r1             apk           
 sqlite-libs                                                                       3.41.2-r2               apk           
 squizlabs/php_codesniffer                                                         3.7.1                   php-composer  
-ssl_client                                                                        1.36.1-r2               apk           
+ssl_client                                                                        1.36.1-r4               apk           
 swiftmailer/swiftmailer                                                           v6.3.0                  php-composer  
 symfony/cache                                                                     v5.4.15                 php-composer  
 symfony/cache-contracts                                                           v2.5.2                  php-composer