Skip to content

Commit 5f1a4d9

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent d1e6866 commit 5f1a4d9

File tree

5 files changed

+78
-42
lines changed

5 files changed

+78
-42
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
[linuxserverurl]: https://linuxserver.io
22
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
33

4-
If you are new to Docker or this application our issue tracker is **ONLY** used for reporting bugs or requesting features. Please use [our discord server](https://discord.gg/YWrKVTn) for general support.
4+
<!--- If you are new to Docker or this application our issue tracker is **ONLY** used for reporting bugs or requesting features. Please use [our discord server](https://discord.gg/YWrKVTn) for general support. --->
5+
6+
<!--- If this acts as a feature request please ask yourself if this modification is something the whole userbase will benefit from --->
7+
<!--- If this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
58

69
<!--- Provide a general summary of the issue in the Title above -->
710

@@ -22,9 +25,10 @@ If you are new to Docker or this application our issue tracker is **ONLY** used
2225
4.
2326

2427
## Environment
25-
**OS:**
26-
**CPU architecture:** x86_64/arm32/arm64
27-
**How docker service was installed:**
28+
**OS:**
29+
**CPU architecture:** x86_64/arm32/arm64
30+
**How docker service was installed:**
31+
<!--- ie. from the official docker repo, from the distro repo, nas OS provided, etc. -->
2832
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
2933

3034
## Command used to create docker container (run/create/compose/screenshot)

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
[linuxserverurl]: https://linuxserver.io
44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
5-
5+
66

77
<!--- Before submitting a pull request please check the following -->
88

9-
<!--- If this is a fix for a typo in code or documentation in the README please file an issue and let us sort it out we do not need a PR -->
9+
<!--- If this is a fix for a typo in code or documentation in the README please file an issue and let us sort it out we do not need a PR -->
1010
<!--- Ask yourself if this modification is something the whole userbase will benefit from, if this is a specific change for corner case functionality or plugins please look at making a Docker Mod or local script https://blog.linuxserver.io/2019/09/14/customizing-our-containers/ -->
1111
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
1212
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
@@ -21,7 +21,11 @@
2121

2222
------------------------------
2323

24-
We welcome all PR’s though this doesn’t guarantee it will be accepted.
24+
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-ldap-auth/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
25+
26+
------------------------------
27+
28+
<!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. -->
2529

2630
## Description:
2731
<!--- Describe your changes in detail -->

‎.github/workflows/greetings.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ jobs:
88
steps:
99
- uses: actions/first-interaction@v1
1010
with:
11-
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [issue template](https://github.com/linuxserver/docker-ldap-auth/.github/ISSUE_TEMPLATE.md)!'
12-
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-ldap-auth/.github/PULL_REQUEST_TEMPLATE.md)!'
11+
issue-message: 'Thanks for opening your first issue here! Be sure to follow the [issue template](https://github.com/linuxserver/docker-ldap-auth/blob/master/.github/ISSUE_TEMPLATE.md)!'
12+
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-ldap-auth/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
1313
repo-token: ${{ secrets.GITHUB_TOKEN }}

‎Jenkinsfile

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ pipeline {
5757
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT
5858
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/'
5959
env.PULL_REQUEST = env.CHANGE_ID
60-
env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE.md ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/greetings.yml ./.github/workflows/stale.yml'
60+
env.TEMPLATED_FILES = 'Jenkinsfile README.md LICENSE ./.github/CONTRIBUTING.md ./.github/FUNDING.yml ./.github/ISSUE_TEMPLATE.md ./.github/PULL_REQUEST_TEMPLATE.md ./.github/workflows/greetings.yml ./.github/workflows/stale.yml'
6161
}
6262
script{
6363
env.LS_RELEASE_NUMBER = sh(
@@ -137,6 +137,7 @@ pipeline {
137137
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
138138
}
139139
env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
140+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
140141
}
141142
}
142143
}
@@ -157,6 +158,7 @@ pipeline {
157158
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
158159
}
159160
env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
161+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
160162
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/'
161163
}
162164
}
@@ -177,6 +179,7 @@ pipeline {
177179
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
178180
}
179181
env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
182+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
180183
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST
181184
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/'
182185
}
@@ -544,15 +547,18 @@ pipeline {
544547
for PUSHIMAGE in "${GITHUBIMAGE}" "${GITLABIMAGE}" "${IMAGE}"; do
545548
docker tag ${IMAGE}:${META_TAG} ${PUSHIMAGE}:${META_TAG}
546549
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:latest
550+
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:${EXT_RELEASE_TAG}
547551
docker push ${PUSHIMAGE}:latest
548552
docker push ${PUSHIMAGE}:${META_TAG}
553+
docker push ${PUSHIMAGE}:${EXT_RELEASE_TAG}
549554
done
550555
'''
551556
}
552557
sh '''#! /bin/bash
553558
for DELETEIMAGE in "${GITHUBIMAGE}" "{GITLABIMAGE}" "${IMAGE}"; do
554559
docker rmi \
555560
${DELETEIMAGE}:${META_TAG} \
561+
${DELETEIMAGE}:${EXT_RELEASE_TAG} \
556562
${DELETEIMAGE}:latest || :
557563
done
558564
'''
@@ -593,12 +599,18 @@ pipeline {
593599
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-latest
594600
docker tag ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-latest
595601
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-latest
602+
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
603+
docker tag ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG}
604+
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
596605
docker push ${MANIFESTIMAGE}:amd64-${META_TAG}
597606
docker push ${MANIFESTIMAGE}:arm32v7-${META_TAG}
598607
docker push ${MANIFESTIMAGE}:arm64v8-${META_TAG}
599608
docker push ${MANIFESTIMAGE}:amd64-latest
600609
docker push ${MANIFESTIMAGE}:arm32v7-latest
601610
docker push ${MANIFESTIMAGE}:arm64v8-latest
611+
docker push ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
612+
docker push ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG}
613+
docker push ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
602614
docker manifest push --purge ${MANIFESTIMAGE}:latest || :
603615
docker manifest create ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:arm32v7-latest ${MANIFESTIMAGE}:arm64v8-latest
604616
docker manifest annotate ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:arm32v7-latest --os linux --arch arm
@@ -607,8 +619,12 @@ pipeline {
607619
docker manifest create ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG}
608620
docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} --os linux --arch arm
609621
docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} --os linux --arch arm64 --variant v8
622+
docker manifest create ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
623+
docker manifest annotate ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG} --os linux --arch arm
624+
docker manifest annotate ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} --os linux --arch arm64 --variant v8
610625
docker manifest push --purge ${MANIFESTIMAGE}:latest
611626
docker manifest push --purge ${MANIFESTIMAGE}:${META_TAG}
627+
docker manifest push --purge ${MANIFESTIMAGE}:${EXT_RELEASE_TAG}
612628
done
613629
docker tag ${IMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:amd64-${META_TAG}
614630
docker tag ${IMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-${META_TAG}
@@ -617,13 +633,21 @@ pipeline {
617633
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:${META_TAG}
618634
docker tag ${GITHUBIMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-latest
619635
docker tag ${GITHUBIMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-latest
636+
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:amd64-${EXT_RELEASE_TAG}
637+
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:${EXT_RELEASE_TAG}
638+
docker tag ${GITHUBIMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-${EXT_RELEASE_TAG}
639+
docker tag ${GITHUBIMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-${EXT_RELEASE_TAG}
620640
docker push ${GITHUBIMAGE}:amd64-${META_TAG}
621641
docker push ${GITHUBIMAGE}:arm32v7-${META_TAG}
622642
docker push ${GITHUBIMAGE}:arm64v8-${META_TAG}
623643
docker push ${GITHUBIMAGE}:latest
624644
docker push ${GITHUBIMAGE}:${META_TAG}
625645
docker push ${GITHUBIMAGE}:arm32v7-latest
626646
docker push ${GITHUBIMAGE}:arm64v8-latest
647+
docker push ${GITHUBIMAGE}:${EXT_RELEASE_TAG}
648+
docker push ${GITHUBIMAGE}:amd64-${EXT_RELEASE_TAG}
649+
docker push ${GITHUBIMAGE}:arm32v7-${EXT_RELEASE_TAG}
650+
docker push ${GITHUBIMAGE}:arm64v8-${EXT_RELEASE_TAG}
627651
'''
628652
}
629653
sh '''#! /bin/bash
@@ -692,7 +716,7 @@ pipeline {
692716
set -e
693717
TEMPDIR=$(mktemp -d)
694718
docker pull linuxserver/jenkins-builder:latest
695-
docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH=master -v ${TEMPDIR}:/ansible/jenkins linuxserver/jenkins-builder:latest
719+
docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH="${BRANCH_NAME}" -v ${TEMPDIR}:/ansible/jenkins linuxserver/jenkins-builder:latest
696720
docker pull lsiodev/readme-sync
697721
docker run --rm=true \
698722
-e DOCKERHUB_USERNAME=$DOCKERUSER \

‎README.md

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2+
<!-- Please read the CONTRIBUTING.md -->
3+
14
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
25

36
[![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!")
@@ -58,27 +61,11 @@ The architectures supported by this image are:
5861

5962
Here are some example snippets to help you get started creating a container.
6063

61-
### docker
62-
63-
```
64-
docker create \
65-
--name=ldap-auth \
66-
-e TZ=Europe/London \
67-
-e FERNETKEY= `#optional` \
68-
-e CERTFILE= `#optional` \
69-
-e KEYFILE= `#optional` \
70-
-p 8888:8888 \
71-
-p 9000:9000 \
72-
--restart unless-stopped \
73-
linuxserver/ldap-auth
74-
```
75-
76-
77-
### docker-compose
64+
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
7865

7966
Compatible with docker-compose v2 schemas.
8067

81-
```
68+
```yaml
8269
---
8370
version: "2.1"
8471
services:
@@ -96,6 +83,22 @@ services:
9683
restart: unless-stopped
9784
```
9885
86+
### docker cli
87+
88+
```
89+
docker run -d \
90+
--name=ldap-auth \
91+
-e TZ=Europe/London \
92+
-e FERNETKEY= `#optional` \
93+
-e CERTFILE= `#optional` \
94+
-e KEYFILE= `#optional` \
95+
-p 8888:8888 \
96+
-p 9000:9000 \
97+
--restart unless-stopped \
98+
linuxserver/ldap-auth
99+
```
100+
101+
99102
## Parameters
100103

101104
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.
@@ -137,9 +140,9 @@ Keep in mind umask is not chmod it subtracts from permissions based on it's valu
137140

138141

139142
## Docker Mods
140-
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&query=%24.mods%5B%27ldap-auth%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=ldap-auth "view available mods for this container.")
143+
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=ldap-auth&query=%24.mods%5B%27ldap-auth%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=ldap-auth "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
141144

142-
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
145+
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
143146

144147

145148
## Support Info
@@ -157,33 +160,34 @@ Most of our images are static, versioned, and require an image update and contai
157160

158161
Below are the instructions for updating containers:
159162

160-
### Via Docker Run/Create
161-
* Update the image: `docker pull linuxserver/ldap-auth`
162-
* Stop the running container: `docker stop ldap-auth`
163-
* Delete the container: `docker rm ldap-auth`
164-
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
165-
* Start the new container: `docker start ldap-auth`
166-
* You can also remove the old dangling images: `docker image prune`
167-
168163
### Via Docker Compose
169164
* Update all images: `docker-compose pull`
170165
* or update a single image: `docker-compose pull ldap-auth`
171166
* Let compose update all containers as necessary: `docker-compose up -d`
172167
* or update a single container: `docker-compose up -d ldap-auth`
173168
* You can also remove the old dangling images: `docker image prune`
174169

175-
### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
170+
### Via Docker Run
171+
* Update the image: `docker pull linuxserver/ldap-auth`
172+
* Stop the running container: `docker stop ldap-auth`
173+
* Delete the container: `docker rm ldap-auth`
174+
* 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)
175+
* You can also remove the old dangling images: `docker image prune`
176+
177+
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
176178
* Pull the latest image at its tag and replace it with the same env variables in one run:
177179
```
178180
docker run --rm \
179181
-v /var/run/docker.sock:/var/run/docker.sock \
180182
containrrr/watchtower \
181183
--run-once ldap-auth
182184
```
185+
* You can also remove the old dangling images: `docker image prune`
183186

184-
**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.
187+
**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).
185188

186-
* You can also remove the old dangling images: `docker image prune`
189+
### Image Update Notifications - Diun (Docker Image Update Notifier)
190+
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
187191

188192
## Building locally
189193

0 commit comments

Comments
 (0)