|
1 |
| - |
2 |
| -[](https://github.com/HEPData/hepdata-converter-ws-docker/actions?query=branch%3Amaster) |
| 1 | +[](https://github.com/HEPData/hepdata-converter-ws-docker/actions?query=branch%3Amain) |
| 2 | +[](https://hub.docker.com/r/hepdata/hepdata-converter) |
3 | 3 |
|
4 | 4 | # hepdata-converter-ws-docker
|
5 | 5 |
|
6 | 6 | *Build system for creating Docker image used to run hepdata-converter-ws*
|
7 | 7 |
|
8 |
| -This is a *companion repository* for the https://github.com/HEPData/hepdata-converter-ws repository. |
| 8 | +This is a *companion repository* for the [hepdata-converter-ws](https://github.com/HEPData/hepdata-converter-ws) repository. |
9 | 9 |
|
10 |
| -This repository automates building Docker images with the help of Travis and then |
11 |
| -pushing them to DockerHub. The docker image installs hepdata-converter-ws from pypi |
12 |
| -and then runs the webservice (on its default port, 5000). |
| 10 | +This repository automates building Docker images with the help of GitHub Actions and then |
| 11 | +pushing them to [Docker Hub](https://hub.docker.com/r/hepdata/hepdata-converter-ws). The Docker image installs |
| 12 | +[hepdata-converter-ws from PyPI](https://pypi.org/project/hepdata-converter-ws/) |
| 13 | +and then runs the web service (on its default port, 5000). |
13 | 14 |
|
14 | 15 | The basic workflow is as follows:
|
15 | 16 |
|
16 |
| -1. Modify Dockerfile (or any other files) (e.g. to fix the pypi version of hepdata-converter-ws) |
| 17 | +1. Modify the `Dockerfile` (or any other files) (e.g. to fix the PyPI version of hepdata-converter-ws) |
17 | 18 | 2. Commit it to the repository
|
18 |
| -3. Push the code |
19 |
| -4. Travis will create Docker image from Dockerfile and upload it to DockerHub |
| 19 | +3. Push the code to GitHub |
| 20 | +4. GitHub Actions will create a Docker image from the ``Dockerfile`` and upload it to Docker Hub |
20 | 21 |
|
21 | 22 | ## For developers
|
22 | 23 |
|
23 |
| -Travis already has DockerHub credentials in its encrypted variables. If credentials are ever changed also |
24 |
| -update secure variables in Travis build, otherwise the image will be created but not uploaded. |
| 24 | +GitHub Actions already has Docker Hub credentials in its encrypted variables. If credentials are ever changed also |
| 25 | +update the secure variables in the GitHub Actions build, otherwise the image will be created but not uploaded. |
25 | 26 |
|
26 |
| -**Warning:** any build on master will trigger upload of the new image (regardless of the branch, |
27 |
| - so be cautious about it, especially if you plan to start breaking things) |
| 27 | +**Warning:** any build on the main branch (or a tagged release) will trigger upload of the new image, |
| 28 | + so be cautious about it, especially if you plan to start breaking things. |
28 | 29 |
|
29 | 30 |
|
30 | 31 | **Run me**
|
|
0 commit comments