Skip to content

Commit d1d37c2

Browse files
committed
global: unpin dependencies and other updates
* Unpin "hepdata-converter" Docker image to use latest image available. * Unpin "hepdata-converter-ws" PyPI package to use latest available. * Refinements to README.md file such as removing mentions of Travis CI. * Rename 'master' branch to 'main'. * Upgrade actions/checkout to latest v4.
1 parent af0551d commit d1d37c2

File tree

3 files changed

+20
-19
lines changed

3 files changed

+20
-19
lines changed

.github/workflows/ci.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Continuous Integration
33
on:
44
push:
55
pull_request:
6-
branches: [ master ]
6+
branches: [ main ]
77
release:
88
types: [ published ]
99

@@ -14,11 +14,11 @@ jobs:
1414
runs-on: ubuntu-latest
1515

1616
steps:
17-
- uses: actions/checkout@v2
17+
- uses: actions/checkout@v4
1818
- name: Build the Docker image
1919
run: docker build . --file Dockerfile --tag hepdata-converter-ws
2020
- name: Deploy
21-
if: contains(github.ref, 'master') || github.event_name == 'release'
21+
if: contains(github.ref, 'main') || github.event_name == 'release'
2222
env:
2323
CI_TAG: ${{ github.event.release.tag_name }}
2424
IMAGE_NAME: hepdata-converter-ws

Dockerfile

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
FROM hepdata/hepdata-converter:0.2.0
1+
FROM hepdata/hepdata-converter:latest
22

3-
RUN pip3 install --upgrade pip
4-
RUN pip3 install -I hepdata-converter-ws==0.2.0
3+
RUN pip install --upgrade pip
4+
RUN pip install hepdata-converter-ws
55

66
CMD hepdata-converter-ws

README.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,31 @@
1-
2-
[![GitHub Actions Status](https://github.com/HEPData/hepdata-converter-ws-docker/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/HEPData/hepdata-converter-ws-docker/actions?query=branch%3Amaster)
1+
[![GitHub Actions Status](https://github.com/HEPData/hepdata-converter-ws-docker/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/HEPData/hepdata-converter-ws-docker/actions?query=branch%3Amain)
2+
[![Docker Pulls](https://img.shields.io/docker/pulls/hepdata/hepdata-converter)](https://hub.docker.com/r/hepdata/hepdata-converter)
33

44
# hepdata-converter-ws-docker
55

66
*Build system for creating Docker image used to run hepdata-converter-ws*
77

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.
99

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).
1314

1415
The basic workflow is as follows:
1516

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)
1718
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
2021

2122
## For developers
2223

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.
2526

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.
2829

2930

3031
**Run me**

0 commit comments

Comments
 (0)