-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Upgrade YODA/ROOT versions, skip_cleanup in travis.yml, tidy README.md
* Upgrade to YODA version 1.7.7 and ROOT version 6.20/00. * Also add `skip_cleanup` to `deploy` part of .travis.yml, see: https://docs.travis-ci.com/user/deployment#uploading-files-and-skip_cleanup * Tidy up the README.md file and add more links. Signed-off-by: Graeme Watt <[email protected]>
- Loading branch information
1 parent
039b1b0
commit c179d3b
Showing
3 changed files
with
38 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,47 @@ | ||
|
||
![Build Status](https://travis-ci.org/HEPData/hepdata-converter-docker.svg?branch=master) | ||
[![Build Status](https://travis-ci.org/HEPData/hepdata-converter-docker.svg?branch=master)](https://travis-ci.org/HEPData/hepdata-converter-docker) | ||
[![Docker Pulls](https://img.shields.io/docker/pulls/hepdata/hepdata-converter)](https://hub.docker.com/r/hepdata/hepdata-converter) | ||
|
||
# hepdata-converter-docker | ||
|
||
*Build system for creating Docker image used by Travis testing framework for hepdata-converter* | ||
**Build system for creating Docker image used by Travis CI testing framework for hepdata-converter** | ||
|
||
This is a *companion repository* for the https://github.com/HEPData/hepdata-converter repository | ||
(it is also included there as a submodule in ```docker``` directory) | ||
This is a *companion repository* for the | ||
[hepdata-converter](https://github.com/HEPData/hepdata-converter) | ||
repository (it is also included there as a submodule in the | ||
`docker` directory). | ||
|
||
This repository has only one purpose, to separate Dockerfile from the main hepdata-converter | ||
repository, in order to automate building Docker images with the help of Travis and then | ||
pushing them to DockerHub. | ||
This repository has only one purpose: to separate the `Dockerfile` from the | ||
main [hepdata-converter](https://github.com/HEPData/hepdata-converter) | ||
repository, in order to automate building Docker images with the help of | ||
[Travis CI](https://travis-ci.org/HEPData/hepdata-converter-docker) and | ||
then pushing them to | ||
[DockerHub](https://hub.docker.com/r/hepdata/hepdata-converter). | ||
|
||
The Docker image `hepdata-converter` contains the | ||
[ROOT](https://root.cern.ch) and [YODA](https://yoda.hepforge.org/) | ||
dependencies needed for running the | ||
[hepdata-converter](https://github.com/HEPData/hepdata-converter) code. | ||
|
||
The basic workflow is as follows: | ||
|
||
1. Modify Dockerfile / requirements.txt (or any other files) | ||
2. Commit it to the repository | ||
3. Push the code | ||
4. Travis will create Docker image from Dockerfile and upload it to DockerHub | ||
1. Modify `Dockerfile` / `requirements.txt` (or any other files). | ||
2. Commit it to the repository. | ||
3. Push the code. | ||
4. Travis will create a Docker image from the `Dockerfile` and upload | ||
it to [DockerHub](https://hub.docker.com/r/hepdata/hepdata-converter). | ||
|
||
## For developers | ||
|
||
This file contains file requirements.txt, it is here on purpose, it should not be duplicated | ||
in hepdata-converter repository. Also Travis already has DockerHub credentials in | ||
its encrypted variables. If credentials are ever changed also update secure | ||
variables in Travis build, otherwise the image will be created but not uploaded. | ||
|
||
**Warning:** any build will trigger upload of the new image (regardless of the branch, | ||
so be cautious about it, especially if you plan to start breaking things) | ||
This repository contains a file `requirements.txt`. It is here on | ||
purpose and should not be duplicated in the | ||
[hepdata-converter](https://github.com/HEPData/hepdata-converter) | ||
repository. Also | ||
[Travis CI](https://travis-ci.org/HEPData/hepdata-converter-docker) | ||
already has DockerHub credentials in its encrypted variables. If | ||
credentials are ever changed, update the secure variables in the Travis | ||
CI build, otherwise the Docker image will be created but not uploaded. | ||
|
||
**Warning:** any build on the master branch (or a tagged release) will | ||
trigger upload of the new Docker image to DockerHub, so be cautious | ||
about it, especially if you plan to start breaking things. |