Skip to content
This repository was archived by the owner on Oct 10, 2022. It is now read-only.

Commit 21fcd70

Browse files
thespadthespad
authored
Merge pull request #8 from linuxserver/deprecate-alpine
2 parents 207da00 + ce4aeb8 commit 21fcd70

17 files changed

+826
-160
lines changed

‎.editorconfig‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# This file is globally distributed to all container image projects from
2+
# https://github.com/linuxserver/docker-jenkins-builder/blob/master/.editorconfig
3+
4+
# top-most EditorConfig file
5+
root = true
6+
7+
# Unix-style newlines with a newline ending every file
8+
[*]
9+
end_of_line = lf
10+
insert_final_newline = true
11+
# trim_trailing_whitespace may cause unintended issues and should not be globally set true
12+
trim_trailing_whitespace = false
13+
14+
[{Dockerfile*,**.yml}]
15+
indent_style = space
16+
indent_size = 2
17+
18+
[{**.sh,root/etc/cont-init.d/**,root/etc/services.d/**}]
19+
indent_style = space
20+
indent_size = 4

‎.github/CONTRIBUTING.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Contributing to baseimage-cloud9
2+
3+
## Gotchas
4+
5+
* While contributing make sure to make all your changes before creating a Pull Request, as our pipeline builds each commit after the PR is open.
6+
* Read, and fill the Pull Request template
7+
* If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR
8+
* If the PR is addressing an existing issue include, closes #\<issue number>, in the body of the PR commit message
9+
* If you want to discuss changes, you can also bring it up in [#dev-talk](https://discordapp.com/channels/354974912613449730/757585807061155840) in our [Discord server](https://discord.gg/YWrKVTn)
10+
11+
## Common files
12+
13+
| File | Use case |
14+
| :----: | --- |
15+
| `Dockerfile` | Dockerfile used to build amd64 images |
16+
| `Dockerfile.aarch64` | Dockerfile used to build 64bit ARM architectures |
17+
| `Dockerfile.armhf` | Dockerfile used to build 32bit ARM architectures |
18+
| `Jenkinsfile` | This file is a product of our builder and should not be edited directly. This is used to build the image |
19+
| `jenkins-vars.yml` | This file is used to generate the `Jenkinsfile` mentioned above, it only affects the build-process |
20+
| `package_versions.txt` | This file is generated as a part of the build-process and should not be edited directly. It lists all the installed packages and their versions |
21+
| `README.md` | This file is a product of our builder and should not be edited directly. This displays the readme for the repository and image registries |
22+
| `readme-vars.yml` | This file is used to generate the `README.md` |
23+
24+
## Readme
25+
26+
If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit.
27+
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-baseimage-cloud9/edit/alpine/readme-vars.yml).
28+
29+
These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play.
30+
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io)
31+
32+
### Fixing typos or clarify the text in the readme
33+
34+
There are variables for multiple parts of the readme, the most common ones are:
35+
36+
| Variable | Description |
37+
| :----: | --- |
38+
| `project_blurb` | This is the short excerpt shown above the project logo. |
39+
| `app_setup_block` | This is the text that shows up under "Application Setup" if enabled |
40+
41+
### Parameters
42+
43+
The compose and run examples are also generated from these variables.
44+
45+
We have a [reference file](https://github.com/linuxserver/docker-jenkins-builder/blob/master/vars/_container-vars-blank) in our Jenkins Builder.
46+
47+
These are prefixed with `param_` for required parameters, or `opt_param` for optional parameters, except for `cap_add`.
48+
Remember to enable param, if currently disabled. This differs between parameters, and can be seen in the reference file.
49+
50+
Devices, environment variables, ports and volumes expects its variables in a certain way.
51+
52+
### Devices
53+
54+
```yml
55+
param_devices:
56+
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
57+
opt_param_devices:
58+
- { device_path: "/dev/dri", device_host_path: "/dev/dri", desc: "For hardware transcoding" }
59+
```
60+
61+
### Environment variables
62+
63+
```yml
64+
param_env_vars:
65+
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
66+
opt_param_env_vars:
67+
- { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." }
68+
```
69+
70+
### Ports
71+
72+
```yml
73+
param_ports:
74+
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
75+
opt_param_ports:
76+
- { external_port: "80", internal_port: "80", port_desc: "Application WebUI" }
77+
```
78+
79+
### Volumes
80+
81+
```yml
82+
param_volumes:
83+
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
84+
opt_param_volumes:
85+
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Configuration files." }
86+
```
87+
88+
### Testing template changes
89+
90+
After you make any changes to the templates, you can use our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) to have the files updated from the modified templates. Please use the command found under `Running Locally` [on this page](https://github.com/linuxserver/docker-jenkins-builder/blob/master/README.md) to generate them prior to submitting a PR.
91+
92+
## Dockerfiles
93+
94+
We use multiple Dockerfiles in our repos, this is because sometimes some CPU architectures needs different packages to work.
95+
If you are proposing additional packages to be added, ensure that you added the packages to all the Dockerfiles in alphabetical order.
96+
97+
### Testing your changes
98+
99+
```bash
100+
git clone https://github.com/linuxserver/docker-baseimage-cloud9.git
101+
cd docker-baseimage-cloud9
102+
docker build \
103+
--no-cache \
104+
--pull \
105+
-t linuxserver/baseimage-cloud9:latest .
106+
```
107+
108+
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109+
110+
```bash
111+
docker run --rm --privileged multiarch/qemu-user-static:register --reset
112+
```
113+
114+
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
115+
116+
## Update the changelog
117+
118+
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-baseimage-cloud9/tree/alpine/root), add an entry to the changelog
119+
120+
```yml
121+
changelogs:
122+
- { date: "DD.MM.YY:", desc: "Added some love to templates" }
123+
```

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
github: linuxserver
12
open_collective: linuxserver

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord chat support
4+
url: https://discord.gg/YWrKVTn
5+
about: Realtime support / chat with the community and the team.
6+
7+
- name: Discourse discussion forum
8+
url: https://discourse.linuxserver.io
9+
about: Post on our community forum.
10+
11+
- name: Documentation
12+
url: https://docs.linuxserver.io
13+
about: Documentation - information about all of our containers.

‎.github/ISSUE_TEMPLATE/issue.bug.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
# DEPRECATION NOTICE
7+
8+
This image is deprecated. We will not offer support for this image and it will not be updated.
9+
10+
[linuxserverurl]: https://linuxserver.io
11+
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
12+
13+
<!--- 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. --->
14+
15+
<!--- Provide a general summary of the bug in the Title above -->
16+
17+
------------------------------
18+
19+
## Expected Behavior
20+
<!--- Tell us what should happen -->
21+
22+
## Current Behavior
23+
<!--- Tell us what happens instead of the expected behavior -->
24+
25+
## Steps to Reproduce
26+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
27+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
28+
1.
29+
2.
30+
3.
31+
4.
32+
33+
## Environment
34+
**OS:**
35+
**CPU architecture:** x86_64/arm32/arm64
36+
**How docker service was installed:**
37+
<!--- ie. from the official docker repo, from the distro repo, nas OS provided, etc. -->
38+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
39+
40+
## Command used to create docker container (run/create/compose/screenshot)
41+
<!--- Provide your docker create/run command or compose yaml snippet, or a screenshot of settings if using a gui to create the container -->
42+
43+
## Docker logs
44+
<!--- Provide a full docker log, output of "docker logs baseimage-cloud9" -->

‎.github/ISSUE_TEMPLATE/issue.feature.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
# DEPRECATION NOTICE
7+
8+
This image is deprecated. We will not offer support for this image and it will not be updated.
9+
10+
[linuxserverurl]: https://linuxserver.io
11+
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
12+
13+
<!--- 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. --->
14+
15+
<!--- If this acts as a feature request please ask yourself if this modification is something the whole userbase will benefit from --->
16+
<!--- 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/ -->
17+
18+
<!--- Provide a general summary of the request in the Title above -->
19+
20+
------------------------------
21+
22+
## Desired Behavior
23+
<!--- Tell us what should happen -->
24+
25+
## Current Behavior
26+
<!--- Tell us what happens instead of the expected behavior -->
27+
28+
## Alternatives Considered
29+
<!--- Tell us what other options you have tried or considered -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1+
# DEPRECATION NOTICE
2+
3+
This image is deprecated. We will not offer support for this image and it will not be updated.
4+
15
<!--- Provide a general summary of your changes in the Title above -->
26

37
[linuxserverurl]: https://linuxserver.io
48
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
5-
9+
610

711
<!--- Before submitting a pull request please check the following -->
812

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 -->
13+
<!--- If this is a fix for a typo (in code, documentation, or the README) please file an issue and let us sort it out. We do not need a PR -->
1014
<!--- 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/ -->
1115
<!--- That if the PR is addressing an existing issue include, closes #<issue number> , in the body of the PR commit message -->
1216
<!--- You have included links to any files / patches etc your PR may be using in the body of the PR commit message -->
@@ -21,7 +25,11 @@
2125

2226
------------------------------
2327

24-
We welcome all PR’s though this doesn’t guarantee it will be accepted.
28+
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-baseimage-cloud9/blob/alpine/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
29+
30+
------------------------------
31+
32+
<!--- We welcome all PR’s though this doesn’t guarantee it will be accepted. -->
2533

2634
## Description:
2735
<!--- Describe your changes in detail -->

‎.github/workflows/external_trigger.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: External Trigger Main
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
external-trigger-alpine:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2.3.3
11+
12+
- name: External Trigger
13+
if: github.ref == 'refs/heads/alpine'
14+
run: |
15+
echo "**** No external release, exiting ****"
16+
exit 0

‎.github/workflows/external_trigger_scheduler.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: External Trigger Scheduler
2+
3+
on:
4+
schedule:
5+
- cron: '35 * * * *'
6+
workflow_dispatch:
7+
8+
jobs:
9+
external-trigger-scheduler:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v2.3.3
13+
with:
14+
fetch-depth: '0'
15+
16+
- name: External Trigger Scheduler
17+
run: |
18+
echo "**** Branches found: ****"
19+
git for-each-ref --format='%(refname:short)' refs/remotes
20+
echo "**** Pulling the yq docker image ****"
21+
docker pull ghcr.io/linuxserver/yq
22+
for br in $(git for-each-ref --format='%(refname:short)' refs/remotes)
23+
do
24+
br=$(echo "$br" | sed 's|origin/||g')
25+
echo "**** Evaluating branch ${br} ****"
26+
ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-baseimage-cloud9/${br}/jenkins-vars.yml \
27+
| docker run --rm -i --entrypoint yq ghcr.io/linuxserver/yq -r .ls_branch)
28+
if [ "$br" == "$ls_branch" ]; then
29+
echo "**** Branch ${br} appears to be live; checking workflow. ****"
30+
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-baseimage-cloud9/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
31+
echo "**** Workflow exists. Triggering external trigger workflow for branch ${br} ****."
32+
curl -iX POST \
33+
-H "Authorization: token ${{ secrets.CR_PAT }}" \
34+
-H "Accept: application/vnd.github.v3+json" \
35+
-d "{\"ref\":\"refs/heads/${br}\"}" \
36+
https://api.github.com/repos/linuxserver/docker-baseimage-cloud9/actions/workflows/external_trigger.yml/dispatches
37+
else
38+
echo "**** Workflow doesn't exist; skipping trigger. ****"
39+
fi
40+
else
41+
echo "**** ${br} appears to be a dev branch; skipping trigger. ****"
42+
fi
43+
done

‎.github/workflows/greetings.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Greetings
2+
3+
on: [pull_request_target, issues]
4+
5+
jobs:
6+
greeting:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/first-interaction@v1
10+
with:
11+
issue-message: 'This image is deprecated. We will not offer support for this image and it will not be updated. The [README](https://github.com/linuxserver/docker-baseimage-cloud9/blob/alpine/README.md) may have additional information. Thanks for opening your first issue here! Be sure to follow the [bug](https://github.com/linuxserver/docker-baseimage-cloud9/blob/alpine/.github/ISSUE_TEMPLATE/issue.bug.md) or [feature](https://github.com/linuxserver/docker-baseimage-cloud9/blob/alpine/.github/ISSUE_TEMPLATE/issue.feature.md) issue templates!'
12+
pr-message: 'This image is deprecated. We will not offer support for this image and it will not be updated. The [README](https://github.com/linuxserver/docker-baseimage-cloud9/blob/alpine/README.md) may have additional information. Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-baseimage-cloud9/blob/alpine/.github/PULL_REQUEST_TEMPLATE.md)!'
13+
repo-token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)