From 8f331fe6c2aed459098de8d6bb1019dbd2a4a295 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Deuchnord?= Date: Mon, 22 Feb 2021 15:14:34 +0100 Subject: [PATCH] ci: remove Docker workflow (already handled on Docker Hub side) (#146) --- .github/workflows/release.yml | 29 +---------------------------- README.md | 30 ++++++++++++++++++++++++++---- 2 files changed, 27 insertions(+), 32 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b884ceb..52fb17a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -81,31 +81,4 @@ jobs: run: | make POEDITOR_API_ACCESS="${POEDITOR_API_ACCESS}" POEDITOR_PROJECT_ID="306433" build twine upload dist/* - docker: - name: Push to DockerHub - runs-on: ubuntu-latest - steps: - - - name: Set up QEMU - uses: docker/setup-qemu-action@v1 - - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v1 - - - name: Login to DockerHub - uses: docker/login-action@v1 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} - - - name: Build and push - id: docker_build - uses: docker/build-push-action@v2 - with: - push: true - file: ./Dockerfile - platforms: linux/amd64,linux/arm64,linux/386 - tags: kosmorro/kosmorro:latest - - - name: Image digest - run: echo ${{ steps.docker_build.outputs.digest }} + diff --git a/README.md b/README.md index 3a85f04..309e50b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # ![Kosmorro](kosmorrolib/assets/png/kosmorro-logo.png) -[![Coverage Status](https://coveralls.io/repos/github/Kosmorro/kosmorro/badge.svg?branch=master)](https://coveralls.io/github/Kosmorro/kosmorro?branch=master) [![Version on PyPI](https://img.shields.io/pypi/v/kosmorro)](https://pypi.org/project/kosmorro) [![Discord](https://img.shields.io/discord/650237632533757965?logo=discord&label=%23kosmorro)](https://discord.gg/TVX4MSKGaa) +[![Coverage Status](https://coveralls.io/repos/github/Kosmorro/kosmorro/badge.svg?branch=master)](https://coveralls.io/github/Kosmorro/kosmorro?branch=master) [![Version on PyPI](https://img.shields.io/pypi/v/kosmorro)](https://pypi.org/project/kosmorro) [![Discord](https://img.shields.io/discord/650237632533757965?logo=discord&label=%23kosmorro)](https://discord.gg/TVX4MSKGaa) ![Docker Pulls](https://img.shields.io/docker/pulls/kosmorro/kosmorro) A program that calculates your astronomical ephemerides! @@ -34,12 +34,34 @@ Kosmorro being at an early-stage development, Windows is not supported officiall #### Docker -Get the official Kosmorro Docker image by running `docker pull kosmorro/kosmorro`. +Kosmorro is available on [Docker Hub](https://hub.docker.com/r/kosmorro/kosmorro)! +You can get it by running `docker pull kosmorro/kosmorro`. -Now that you have the image, you can run it with `docker run -it kosmorro`. +Now that you have the image, you can run it with `docker run -it kosmorro/kosmorro`. Run Kosmorro by executing `kosmorro` in the container. -You can also run the image with the command: `docker run kosmorro kosmorro [args]`. +You can also run the image with the command: `docker run kosmorro/kosmorro kosmorro [args]`. + +Note that for more convenience, you might add the following in your `.bashrc`/`.zshrc`/etc.: + +```bash +alias kosmorro="docker run kosmorro/kosmorro kosmorro" +``` + +##### Image versioning on Docker Hub + +By default, running `docker pull kosmorro/kosmorro` will download the `latest` tag by default, which corresponds to the last version of Kosmorro. +If you prefer, you can also force pulling a specific version by specifying it after the `:` character: `docker pull kosmorro/kosmorro:[version]`. + +As of version 0.10, five kinds of tags are available: + +| Tag | Description | Example +| --- | --- | --- +| `unstable` | the current code in the `master` branch, for testing purpose | `kosmorro/kosmorro:unstable` +| `latest` | the last version (equivalent to not specifying any tag) | `kosmorro/kosmorro:latest` +| `x` | the last version in the `x` major version | `kosmorro/kosmorro:0`: will pull the ![last version in the `0` major branch](https://img.shields.io/docker/v/kosmorro/kosmorro/0?style=flat-square) +| `x.y` | the last version in the `x.y` minor version | `kosmorro/kosmorro:0.10`: will pull the ![last version in the `0` major branch](https://img.shields.io/docker/v/kosmorro/kosmorro/0.10?style=flat-square) +| `x.y.z` | the exact specified version | `kosmorro/kosmorro:0.10.0` ### Development environment