-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.md.template
212 lines (135 loc) · 8.88 KB
/
README.md.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# update-check-runner
The containers that run updates for [violinist.io](https://violinist.io), a PHP / Composer dependency updater for Bitbucket / GitHub / GitLab / Self Hosted GitLab.
Also available as standalone docker containers to self host the update running.
[](https://github.com/violinist-dev/update-check-runner/actions/workflows/test.yml)
[](https://violinist.io)
[](https://github.com/violinist-dev/update-check-runner/pkgs/container/update-check-runner)
## Quick start
Don't even have time for a quick start? Here are some examples:
<details>
<summary>Example for GitLab</summary>
```bash
docker run \
--pull=always \
-e "LICENCE_KEY=my_key" \
-e "PROJECT_URL=https://gitlab.com/user/repo" \
-e "USER_TOKEN=glpat-jjYgGb_1npvkiHTdnM" \
ghcr.io/violinist-dev/update-check-runner:8.3-multi-composer-2
```
</details>
<details>
<summary>Example for GitHub</summary>
```bash
docker run \
--pull=always \
-e "LICENCE_KEY=my_key" \
-e "PROJECT_URL=https://github.com/user/repo" \
-e "USER_TOKEN=ghp_jYgGb_1npvkiHTdnM" \
ghcr.io/violinist-dev/update-check-runner:8.3-multi-composer-2
```
</details>
<details>
<summary>Example for Bitbucket</summary>
```bash
docker run \
--pull=always \
-e "LICENCE_KEY=my_key" \
-e "PROJECT_URL=https://bitbucket.org/org/project/repo" \
-e "USER_TOKEN=myusername:app_p455w0rd" \
ghcr.io/violinist-dev/update-check-runner:8.3-multi-composer-2
```
</details>
### 0. Find a repository to check for updates
Copy the URL of the repository you want to check for updates. For the purpose of this quick start guide, let's assume this is `https://gitlab.com/user/repo`.
### 1. Obtain an access token / app password
- For GitHub visit [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new)
- For Bitbucket visit [https://bitbucket.org/account/settings/app-passwords/new](https://bitbucket.org/account/settings/app-passwords/new). Please note your argument to running updates must include your username (see notice below).
- For Gitlab visit [https://gitlab.com/-/user_settings/personal_access_tokens](https://gitlab.com/-/user_settings/personal_access_tokens)
- For self hosted Gitlab visit [https://gitlab.example.com/-/user_settings/personal_access_tokens](https://gitlab.example.com/-/user_settings/personal_access_tokens) (replace with your own domain)
For the purpose of this quick start guide let's assume the token is `glpat-jjYgGb_1npvkiHTdnM`.
> 🚨️ For bitbucket your token should include both your username and your application password separated with a colon (`:`). For example `user:p455w0r0`.
### 2. Obtain a license key from violinist.io
You can do this in one of the following ways:
- Use a license key somehow provided to you
- Use a trial license from [https://violinist.io/self-hosted-trial](https://violinist.io/self-hosted-trial)
- Purchase a license on [https://violinist.io/purchase-licence](https://violinist.io/purchase-licence)
For the purpose of this quick start guide, let's assume the license key is `fYtLakIxFEBdy1vB_SU3iaPrTRwVugFnj9AGxRYVsRSha-ju3m7qpFNHhwPn_C5vS38tDGW6jo_DOI7zZfcy5n6cu7_3ef8vU8HyfS6cyrR6Xq767XOcvqb1KKgoCKqo6_vyI02pWk6YgyU3gsrqgaS5pwcVo9aNY2AQbS1TZABJjwWRHCUqNrCK7pTd2TE6hA01rMQKTJUNmjlLjbYlYc4c3TQxS6iqYH8`
### 3. Run the appropriate container
Choose the PHP version and composer version relevant to your project. For the purpose of this quick start guide, let's assume we use PHP 8.3 and Composer 2.
That means we should run the following docker image:
> ghcr.io/violinist-dev/update-check-runner:`8.3`-multi-composer-`2`
Putting it all together with your noted arguments:
```bash
docker run \
--pull=always \
-e "LICENCE_KEY=fYtLakIxFEBdy1vB_SU3iaPrTRwVugFnj9AGxRYVsRSha-ju3m7qpFNHhwPn_C5vS38tDGW6jo_DOI7zZfcy5n6cu7_3ef8vU8HyfS6cyrR6Xq767XOcvqb1KKgoCKqo6_vyI02pWk6YgyU3gsrqgaS5pwcVo9aNY2AQbS1TZABJjwWRHCUqNrCK7pTd2TE6hA01rMQKTJUNmjlLjbYlYc4c3TQxS6iqYH8" \
-e "PROJECT_URL=https://gitlab.com/user/repo" \
-e "USER_TOKEN=glpat-jjYgGb_1npvkiHTdnM" \
ghcr.io/violinist-dev/update-check-runner:8.3-multi-composer-2
```
## Variables
### At a glance
| Name | Required | Default value |
| -- | -- | -- |
| LICENCE_KEY | Yes | |
| USER_TOKEN | Yes| |
| PROJECT_URL | Yes | |
| GIT_AUTHOR_NAME | No | violinist-bot |
| GIT_AUTHOR_EMAIL | No | [email protected] |
| GIT_COMMITTER_NAME | No | violinist-bot |
| GIT_COMMITTER_EMAIL | No | [email protected] |
| ALTERNATE_COMPOSER_PATH | No | |
### Reference
#### LICENCE_KEY
The licence key either handed to you, obtained or purchased for running your own update runners.
Please note the below key is an example, which is signed with an invalid private key.
Example value: `fYtLakIxFEBdy1vB_SU3iaPrTRwVugFnj9AGxRYVsRSha-ju3m7qpFNHhwPn_C5vS38tDGW6jo_DOI7zZfcy5n6cu7_3ef8vU8HyfS6cyrR6Xq767XOcvqb1KKgoCKqo6_vyI02pWk6YgyU3gsrqgaS5pwcVo9aNY2AQbS1TZABJjwWRHCUqNrCK7pTd2TE6hA01rMQKTJUNmjlLjbYlYc4c3TQxS6iqYH8`
#### USER_TOKEN
A token valid for accessing the API, cloning the repo, pushing branches and creating pull requests on behalf of the user in question. Usually this will be a personal access token (PAT) or an app password.
Example value: `ghp_eIgde31jggU3GIBB22fJbv2odcd0xy0e9jh8`
#### PROJECT_URL
The repository to run update checks on.
Example value: `https://github.com/violinist-dev/update-check-runner`
#### GIT_AUTHOR_NAME
An environment variable used for git commits. From the git documentation:
> GIT_AUTHOR_NAME is the human-readable name in the “author” field.
[See "10.8 Git Internals - Environment Variables" for more information](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables)
#### GIT_AUTHOR_EMAIL
An environment variable used for git commits. From the git documentation:
> GIT_AUTHOR_EMAIL is the email for the “author” field.
[See "10.8 Git Internals - Environment Variables" for more information](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables)
#### GIT_COMMITTER_NAME
An environment variable used for git commits. From the git documentation:
> GIT_COMMITTER_NAME sets the human name for the “committer” field.
[See "10.8 Git Internals - Environment Variables" for more information](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables)
#### GIT_COMMITTER_EMAIL
An environment variable used for git commits. From the git documentation:
> GIT_COMMITTER_EMAIL is the email address for the “committer” field.
[See "10.8 Git Internals - Environment Variables" for more information](https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables)
#### ALTERNATE_COMPOSER_PATH
An alternate path to use for the composer executable. For example, this is what you would use, should you want to use (or are forced to use) Composer 2.2 LTS instead of the latest version.
You can only set this value to one of the following alternatives, otherwise it will be ignored:
- `/usr/local/bin/composer22` (this will be the latest Composer 2.2 LTS release)
## Extensions
The following PHP extensions are available in the containers (long table, click to expand):
<details>
<summary>Click to expand</summary>
INSERT_TABLE_HERE
</details>
## FAQ
<details>
<summary><strong>What is the difference between self hosting and using violinist.io (the SaaS)</strong></summary>
In practice, all the automation, convenience, logging and persistance you would have to need.
- No formatting, storing or analysis of logs. You would have to implement this yourself if needed.
- No notifications (email or slack)
- No automatic discovery of PHP version. When your project upgrade to a new version, you must also change the PHP version of the update container
- No private keys per project or per organization
</details>
<details>
<summary><strong>Can I use this to run updates for my clients or customers and charge money for it?</strong></summary>
Yes. There are no restrictions on what you use the licence key for, and if you use it for commercial purposes or something else.
You are not allowed to provide the same service as violinist.io (sell licences to this software, or provide a SaaS based on this software). But please go ahead and purchase a licence and charge your customers multiples of that to provide the service you purchased.
Otherwise, we refer to the licence of this repo: [https://github.com/violinist-dev/update-check-runner/blob/main/LICENSE](https://github.com/violinist-dev/update-check-runner/blob/main/LICENSE)
</details>
## Licence
Licenced under the commercial [violinist licence](https://github.com/violinist-dev/update-check-runner/blob/main/LICENSE)