Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove Dockerfile #98

Merged
merged 3 commits into from
Feb 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,3 @@ jobs:
with:
user: __token__
password: ${{ secrets.PYPI_TOKEN }}

push_to_registry:
name: Push Docker image to Docker Hub
runs-on: ubuntu-latest
steps:
- name: Check out the repo
uses: actions/checkout@v2
- name: Push to Docker Hub
uses: docker/build-push-action@v1
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_TOKEN }}
repository: snakemake/snakefmt
tags: latest
tag_with_ref: true
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## [unreleased]

### Removed

- `Dockerfile` has been removed as the
[biocontainers](https://hub.docker.com/r/snakemake/snakefmt/tags) images are smaller
and some recent changes to the `cryptography` dependency require Rust to be installed
(on Alpine) which further bloats our DockerHub image.

## [0.3.0]

### Changed
Expand Down
14 changes: 0 additions & 14 deletions Dockerfile

This file was deleted.

29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,31 +57,22 @@ conda install -c bioconda snakefmt

### Containers

#### Docker

[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/snakemake/snakefmt)](https://hub.docker.com/r/snakemake/snakefmt/tags)
As `snakefmt` has a Conda recipe, there is a matching image built for each version by
Biocontainers.

```sh
docker pull snakemake/snakefmt
docker run -it snakemake/snakefmt snakefmt --help
```
In the following examples, all tags (`<tag>`) can be found
[here](https://quay.io/repository/biocontainers/snakefmt?tab=tags).

You can find all the available tags on the [Docker Hub repository][dockerhub].

[dockerhub]: https://hub.docker.com/r/snakemake/snakefmt

#### Singularity
#### Docker

```sh
URI="docker://snakemake/snakefmt"
singularity exec "$URI" snakefmt --help
```shell
$ docker run -it "quay.io/biocontainers/snakefmt:<tag>" snakefmt --help
```

The above will use the latest version. If you want to specify a version then use a [tag][dockerhub] like so.
#### Singularity

```sh
VERSION="x.x.x"
URI="docker://snakemake/snakefmt:${VERSION}"
```shell
$ singularity exec "docker://quay.io/biocontainers/snakefmt:<tag>" snakefmt --help
```

### Local
Expand Down