|
| 1 | +# Docker Image with git-crypt |
| 2 | + |
| 3 | +[](https://circleci.com/gh/PicturePipe/workflows/docker-git-crypt "CircleCI Build") |
| 4 | +[](https://renovateapp.com/ "Renovate enabled") |
| 5 | + |
| 6 | +[Docker](https://www.docker.com) image with [git-crypt](https://github.com/AGWA/git-crypt). |
| 7 | + |
| 8 | +## Repository |
| 9 | + |
| 10 | +The docker images are available in our [repository](https://quay.io/repository/picturepipe/git-crypt): |
| 11 | + |
| 12 | +```console |
| 13 | +docker pull quay.io/picturepipe/git-crypt |
| 14 | +``` |
| 15 | + |
| 16 | +## Usage |
| 17 | + |
| 18 | +This image can be used directly if you need to decrypt repositories in CI. |
| 19 | + |
| 20 | +There is also wrapper script which allows you to use this docker image to run `git-crypt` as if |
| 21 | +it was installed on your machine. |
| 22 | + |
| 23 | +To use that script, install it somewhere into your `PATH`: |
| 24 | + |
| 25 | +```console |
| 26 | +sudo cp wrapper.sh /usr/local/bin/git-crypt |
| 27 | +``` |
| 28 | + |
| 29 | +## Tags |
| 30 | + |
| 31 | +The latest released version is tagged as `latest`. |
| 32 | + |
| 33 | +The releases will follow the upstream version, with an optional dash and number appended, if there |
| 34 | +are multiple releases per upstream version. |
| 35 | + |
| 36 | +So for example, the first release for upstream version `0.6.0` will be tagged `0.6.0`. If there |
| 37 | +is a second release for this upstream version, it will be tagged `0.6.0-1`. |
| 38 | + |
| 39 | +## Preparing a release |
| 40 | + |
| 41 | +This project uses gitflow. To create a release, first start the release branch for the version |
| 42 | +which you want to release: |
| 43 | + |
| 44 | +```console |
| 45 | +git flow release start 0.6.0 |
| 46 | +``` |
| 47 | + |
| 48 | +Perform any release related changes. At the very least, this means updating the current tag given in |
| 49 | +`README.md`. |
| 50 | + |
| 51 | +Now, publish the release: |
| 52 | + |
| 53 | +```console |
| 54 | +git flow release publish |
| 55 | +``` |
| 56 | + |
| 57 | +This will push the branch to GitHub and trigger a run of CI. Once CI is complete and all tests have |
| 58 | +passed, finish the release and push the tag to GitHub: |
| 59 | + |
| 60 | +```console |
| 61 | +git flow release finish --push --tag |
| 62 | +``` |
| 63 | + |
| 64 | +## License |
| 65 | + |
| 66 | +Distributed under the MIT license. |
| 67 | + |
| 68 | +Copyright 2019 reelport GmbH |
0 commit comments