diff --git a/.github/workflows/external_trigger.yml b/.github/workflows/external_trigger.yml index 276e0eb..d6a8576 100755 --- a/.github/workflows/external_trigger.yml +++ b/.github/workflows/external_trigger.yml @@ -18,7 +18,7 @@ jobs: fi echo "**** External trigger running off of development branch. To disable this trigger, set a Github secret named \"PAUSE_EXTERNAL_TRIGGER_HEIMDALL_DEVELOPMENT\". ****" echo "**** Retrieving external version ****" - EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" | jq -r '. | .sha' | cut -c1-8) + EXT_RELEASE=$(curl -u "${{ secrets.CR_USER }}:${{ secrets.CR_PAT }}" -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" | jq -r '. | .sha' | cut -c1-8) if [ -z "${EXT_RELEASE}" ] || [ "${EXT_RELEASE}" == "null" ]; then echo "**** Can't retrieve external version, exiting ****" FAILURE_REASON="Can't retrieve external version for heimdall branch development" diff --git a/Dockerfile b/Dockerfile index ca3c4e8..ed82ea2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -22,7 +22,7 @@ RUN \ mkdir -p \ /heimdall && \ if [ -z ${HEIMDALL_RELEASE+x} ]; then \ - HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" \ + HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" \ | awk '/sha/{print $4;exit}' FS='[""]'); \ fi && \ curl -o \ diff --git a/Dockerfile.aarch64 b/Dockerfile.aarch64 index 6130940..66d5f7a 100644 --- a/Dockerfile.aarch64 +++ b/Dockerfile.aarch64 @@ -22,7 +22,7 @@ RUN \ mkdir -p \ /heimdall && \ if [ -z ${HEIMDALL_RELEASE+x} ]; then \ - HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" \ + HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" \ | awk '/sha/{print $4;exit}' FS='[""]'); \ fi && \ curl -o \ diff --git a/Dockerfile.armhf b/Dockerfile.armhf index afd6d07..b2f906d 100644 --- a/Dockerfile.armhf +++ b/Dockerfile.armhf @@ -22,7 +22,7 @@ RUN \ mkdir -p \ /heimdall && \ if [ -z ${HEIMDALL_RELEASE+x} ]; then \ - HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/master" \ + HEIMDALL_RELEASE=$(curl -sX GET "https://api.github.com/repos/linuxserver/Heimdall/commits/2.x" \ | awk '/sha/{print $4;exit}' FS='[""]'); \ fi && \ curl -o \ diff --git a/Jenkinsfile b/Jenkinsfile index 4824d33..2ce1171 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -17,7 +17,7 @@ pipeline { GITLAB_TOKEN=credentials('b6f0f1dd-6952-4cf6-95d1-9c06380283f0') GITLAB_NAMESPACE=credentials('gitlab-namespace-id') SCARF_TOKEN=credentials('scarf_api_key') - EXT_GIT_BRANCH = 'master' + EXT_GIT_BRANCH = '2.x' EXT_USER = 'linuxserver' EXT_REPO = 'Heimdall' CONTAINER_NAME = 'heimdall' diff --git a/README.md b/README.md index 0b485d3..4d434a2 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,15 @@ The architectures supported by this image are: | arm64 | ✅ | arm64v8-\ | | armhf| ✅ | arm32v7-\ | +## Version Tags + +This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags. + +| Tag | Available | Description | +| :----: | :----: |--- | +| latest | ✅ | Stable Heimdall releases. | +| development | ✅ | Latest commit from the github 2.x branch. | + ## Application Setup Access the web gui at http://SERVERIP:PORT @@ -87,7 +96,7 @@ services: - PGID=1000 - TZ=Europe/London volumes: - - :/config + - /path/to/appdata/config:/config ports: - 80:80 - 443:443 @@ -104,16 +113,11 @@ docker run -d \ -e TZ=Europe/London \ -p 80:80 \ -p 443:443 \ - -v :/config \ + -v /path/to/appdata/config:/config \ --restart unless-stopped \ lscr.io/linuxserver/heimdall:development ``` -Using tags, you can switch between the stable releases of Heimdall and the master branch. No tag is required for the latest stable release. -Add the development tag, if required, to the linuxserver/heimdall line of the run/create command in the following format, linuxserver/heimdall:development -The development tag will be the latest commit in the master branch of Heimdall. -HOWEVER , USE THE DEVELOPMENT TAG AT YOUR OWN PERIL !!!!!!!!! - ## Parameters Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -236,6 +240,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions +* **04.11.22:** - Build commits to upstream branch 2.x. * **13.03.21:** - Make searchproviders.yaml user configurable. * **11.03.21:** - Rebase to alpine 3.14. * **10.02.21:** - Revert to alpine 3.12 as php 7.4 broke laravel. diff --git a/jenkins-vars.yml b/jenkins-vars.yml index a4e9fc5..20f0901 100644 --- a/jenkins-vars.yml +++ b/jenkins-vars.yml @@ -7,7 +7,7 @@ release_type: prerelease release_tag: development ls_branch: development repo_vars: - - EXT_GIT_BRANCH = 'master' + - EXT_GIT_BRANCH = '2.x' - EXT_USER = 'linuxserver' - EXT_REPO = 'Heimdall' - CONTAINER_NAME = 'heimdall' diff --git a/readme-vars.yml b/readme-vars.yml index 693f6b1..f5c2539 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -17,12 +17,18 @@ available_architectures: - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"} - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"} +# development version +development_versions: true +development_versions_items: + - { tag: "latest", desc: "Stable Heimdall releases." } + - { tag: "development", desc: "Latest commit from the github 2.x branch." } + # container parameters common_param_env_vars_enabled: true param_container_name: "{{ project_name }}" param_usage_include_vols: true param_volumes: - - { vol_path: "/config", vol_host_path: "", desc: "Contains all relevant configuration files." } + - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Contains all relevant configuration files." } param_usage_include_ports: true param_ports: - { external_port: "80", internal_port: "80", port_desc: "http gui" } @@ -32,7 +38,7 @@ param_env_vars: - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"} # optional parameters -optional_block_1: true +optional_block_1: false optional_block_1_items: - | Using tags, you can switch between the stable releases of Heimdall and the master branch. No tag is required for the latest stable release. @@ -52,6 +58,7 @@ app_setup_block: | # changelog changelogs: + - { date: "04.11.22:", desc: "Build commits to upstream branch 2.x." } - { date: "13.03.21:", desc: "Make searchproviders.yaml user configurable." } - { date: "11.03.21:", desc: "Rebase to alpine 3.14." } - { date: "10.02.21:", desc: "Revert to alpine 3.12 as php 7.4 broke laravel." }