Skip to content

Commit b951132

Browse files
LinuxServer-CILinuxServer-CI
committed
Bot Updating Templated Files
1 parent b24b195 commit b951132

File tree

5 files changed

+81
-45
lines changed

5 files changed

+81
-45
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-bookstack/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-bookstack/.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-bookstack/.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-bookstack/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-bookstack/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
@@ -58,7 +58,7 @@ pipeline {
5858
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/commit/' + env.GIT_COMMIT
5959
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DOCKERHUB_IMAGE + '/tags/'
6060
env.PULL_REQUEST = env.CHANGE_ID
61-
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'
61+
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'
6262
}
6363
script{
6464
env.LS_RELEASE_NUMBER = sh(
@@ -146,6 +146,7 @@ pipeline {
146146
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
147147
}
148148
env.META_TAG = env.EXT_RELEASE_CLEAN + '-ls' + env.LS_TAG_NUMBER
149+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
149150
}
150151
}
151152
}
@@ -166,6 +167,7 @@ pipeline {
166167
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
167168
}
168169
env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-dev-' + env.COMMIT_SHA
170+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
169171
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.DEV_DOCKERHUB_IMAGE + '/tags/'
170172
}
171173
}
@@ -186,6 +188,7 @@ pipeline {
186188
env.CI_TAGS = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
187189
}
188190
env.META_TAG = env.EXT_RELEASE_CLEAN + '-pkg-' + env.PACKAGE_TAG + '-pr-' + env.PULL_REQUEST
191+
env.EXT_RELEASE_TAG = 'version-' + env.EXT_RELEASE_CLEAN
189192
env.CODE_URL = 'https://github.com/' + env.LS_USER + '/' + env.LS_REPO + '/pull/' + env.PULL_REQUEST
190193
env.DOCKERHUB_LINK = 'https://hub.docker.com/r/' + env.PR_DOCKERHUB_IMAGE + '/tags/'
191194
}
@@ -553,15 +556,18 @@ pipeline {
553556
for PUSHIMAGE in "${GITHUBIMAGE}" "${GITLABIMAGE}" "${IMAGE}"; do
554557
docker tag ${IMAGE}:${META_TAG} ${PUSHIMAGE}:${META_TAG}
555558
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:latest
559+
docker tag ${PUSHIMAGE}:${META_TAG} ${PUSHIMAGE}:${EXT_RELEASE_TAG}
556560
docker push ${PUSHIMAGE}:latest
557561
docker push ${PUSHIMAGE}:${META_TAG}
562+
docker push ${PUSHIMAGE}:${EXT_RELEASE_TAG}
558563
done
559564
'''
560565
}
561566
sh '''#! /bin/bash
562567
for DELETEIMAGE in "${GITHUBIMAGE}" "{GITLABIMAGE}" "${IMAGE}"; do
563568
docker rmi \
564569
${DELETEIMAGE}:${META_TAG} \
570+
${DELETEIMAGE}:${EXT_RELEASE_TAG} \
565571
${DELETEIMAGE}:latest || :
566572
done
567573
'''
@@ -602,12 +608,18 @@ pipeline {
602608
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-latest
603609
docker tag ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-latest
604610
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-latest
611+
docker tag ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
612+
docker tag ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG}
613+
docker tag ${MANIFESTIMAGE}:arm64v8-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
605614
docker push ${MANIFESTIMAGE}:amd64-${META_TAG}
606615
docker push ${MANIFESTIMAGE}:arm32v7-${META_TAG}
607616
docker push ${MANIFESTIMAGE}:arm64v8-${META_TAG}
608617
docker push ${MANIFESTIMAGE}:amd64-latest
609618
docker push ${MANIFESTIMAGE}:arm32v7-latest
610619
docker push ${MANIFESTIMAGE}:arm64v8-latest
620+
docker push ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG}
621+
docker push ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG}
622+
docker push ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
611623
docker manifest push --purge ${MANIFESTIMAGE}:latest || :
612624
docker manifest create ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:amd64-latest ${MANIFESTIMAGE}:arm32v7-latest ${MANIFESTIMAGE}:arm64v8-latest
613625
docker manifest annotate ${MANIFESTIMAGE}:latest ${MANIFESTIMAGE}:arm32v7-latest --os linux --arch arm
@@ -616,8 +628,12 @@ pipeline {
616628
docker manifest create ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:amd64-${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG}
617629
docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm32v7-${META_TAG} --os linux --arch arm
618630
docker manifest annotate ${MANIFESTIMAGE}:${META_TAG} ${MANIFESTIMAGE}:arm64v8-${META_TAG} --os linux --arch arm64 --variant v8
631+
docker manifest create ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:amd64-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG}
632+
docker manifest annotate ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm32v7-${EXT_RELEASE_TAG} --os linux --arch arm
633+
docker manifest annotate ${MANIFESTIMAGE}:${EXT_RELEASE_TAG} ${MANIFESTIMAGE}:arm64v8-${EXT_RELEASE_TAG} --os linux --arch arm64 --variant v8
619634
docker manifest push --purge ${MANIFESTIMAGE}:latest
620635
docker manifest push --purge ${MANIFESTIMAGE}:${META_TAG}
636+
docker manifest push --purge ${MANIFESTIMAGE}:${EXT_RELEASE_TAG}
621637
done
622638
docker tag ${IMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:amd64-${META_TAG}
623639
docker tag ${IMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-${META_TAG}
@@ -626,13 +642,21 @@ pipeline {
626642
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:${META_TAG}
627643
docker tag ${GITHUBIMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-latest
628644
docker tag ${GITHUBIMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-latest
645+
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:amd64-${EXT_RELEASE_TAG}
646+
docker tag ${GITHUBIMAGE}:amd64-${META_TAG} ${GITHUBIMAGE}:${EXT_RELEASE_TAG}
647+
docker tag ${GITHUBIMAGE}:arm32v7-${META_TAG} ${GITHUBIMAGE}:arm32v7-${EXT_RELEASE_TAG}
648+
docker tag ${GITHUBIMAGE}:arm64v8-${META_TAG} ${GITHUBIMAGE}:arm64v8-${EXT_RELEASE_TAG}
629649
docker push ${GITHUBIMAGE}:amd64-${META_TAG}
630650
docker push ${GITHUBIMAGE}:arm32v7-${META_TAG}
631651
docker push ${GITHUBIMAGE}:arm64v8-${META_TAG}
632652
docker push ${GITHUBIMAGE}:latest
633653
docker push ${GITHUBIMAGE}:${META_TAG}
634654
docker push ${GITHUBIMAGE}:arm32v7-latest
635655
docker push ${GITHUBIMAGE}:arm64v8-latest
656+
docker push ${GITHUBIMAGE}:${EXT_RELEASE_TAG}
657+
docker push ${GITHUBIMAGE}:amd64-${EXT_RELEASE_TAG}
658+
docker push ${GITHUBIMAGE}:arm32v7-${EXT_RELEASE_TAG}
659+
docker push ${GITHUBIMAGE}:arm64v8-${EXT_RELEASE_TAG}
636660
'''
637661
}
638662
sh '''#! /bin/bash
@@ -701,7 +725,7 @@ pipeline {
701725
set -e
702726
TEMPDIR=$(mktemp -d)
703727
docker pull linuxserver/jenkins-builder:latest
704-
docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH=master -v ${TEMPDIR}:/ansible/jenkins linuxserver/jenkins-builder:latest
728+
docker run --rm -e CONTAINER_NAME=${CONTAINER_NAME} -e GITHUB_BRANCH="${BRANCH_NAME}" -v ${TEMPDIR}:/ansible/jenkins linuxserver/jenkins-builder:latest
705729
docker pull lsiodev/readme-sync
706730
docker run --rm=true \
707731
-e DOCKERHUB_USERNAME=$DOCKERUSER \

‎README.md

Lines changed: 38 additions & 34 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!")
@@ -63,30 +66,11 @@ The architectures supported by this image are:
6366

6467
Here are some example snippets to help you get started creating a container.
6568

66-
### docker
67-
68-
```
69-
docker create \
70-
--name=bookstack \
71-
-e PUID=1000 \
72-
-e PGID=1000 \
73-
-e DB_HOST=<yourdbhost> \
74-
-e DB_USER=<yourdbuser> \
75-
-e DB_PASS=<yourdbpass> \
76-
-e DB_DATABASE=bookstackapp \
77-
-e APP_URL=http://your.site.here.xyz `#optional` \
78-
-p 6875:80 \
79-
-v /path/to/data:/config \
80-
--restart unless-stopped \
81-
linuxserver/bookstack
82-
```
83-
84-
85-
### docker-compose
69+
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
8670

8771
Compatible with docker-compose v2 schemas.
8872

89-
```
73+
```yaml
9074
---
9175
version: "2"
9276
services:
@@ -124,6 +108,25 @@ services:
124108

125109
```
126110

111+
### docker cli
112+
113+
```
114+
docker run -d \
115+
--name=bookstack \
116+
-e PUID=1000 \
117+
-e PGID=1000 \
118+
-e DB_HOST=<yourdbhost> \
119+
-e DB_USER=<yourdbuser> \
120+
-e DB_PASS=<yourdbpass> \
121+
-e DB_DATABASE=bookstackapp \
122+
-e APP_URL=http://your.site.here.xyz `#optional` \
123+
-p 6875:80 \
124+
-v /path/to/data:/config \
125+
--restart unless-stopped \
126+
linuxserver/bookstack
127+
```
128+
129+
127130
## Parameters
128131

129132
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.
@@ -196,9 +199,9 @@ The path to wkhtmltopdf in this image to include in your .env file is `/usr/bin/
196199

197200

198201
## Docker Mods
199-
[![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%27bookstack%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=bookstack "view available mods for this container.")
202+
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=bookstack&query=%24.mods%5B%27bookstack%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=bookstack "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.")
200203

201-
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.
204+
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.
202205

203206

204207
## Support Info
@@ -216,33 +219,34 @@ Most of our images are static, versioned, and require an image update and contai
216219

217220
Below are the instructions for updating containers:
218221

219-
### Via Docker Run/Create
220-
* Update the image: `docker pull linuxserver/bookstack`
221-
* Stop the running container: `docker stop bookstack`
222-
* Delete the container: `docker rm bookstack`
223-
* 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)
224-
* Start the new container: `docker start bookstack`
225-
* You can also remove the old dangling images: `docker image prune`
226-
227222
### Via Docker Compose
228223
* Update all images: `docker-compose pull`
229224
* or update a single image: `docker-compose pull bookstack`
230225
* Let compose update all containers as necessary: `docker-compose up -d`
231226
* or update a single container: `docker-compose up -d bookstack`
232227
* You can also remove the old dangling images: `docker image prune`
233228

234-
### Via Watchtower auto-updater (especially useful if you don't remember the original parameters)
229+
### Via Docker Run
230+
* Update the image: `docker pull linuxserver/bookstack`
231+
* Stop the running container: `docker stop bookstack`
232+
* Delete the container: `docker rm bookstack`
233+
* 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)
234+
* You can also remove the old dangling images: `docker image prune`
235+
236+
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
235237
* Pull the latest image at its tag and replace it with the same env variables in one run:
236238
```
237239
docker run --rm \
238240
-v /var/run/docker.sock:/var/run/docker.sock \
239241
containrrr/watchtower \
240242
--run-once bookstack
241243
```
244+
* You can also remove the old dangling images: `docker image prune`
242245

243-
**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.
246+
**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).
244247

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

247251
## Building locally
248252

0 commit comments

Comments
 (0)