Skip to content

Commit

Permalink
Annotate package installs
Browse files Browse the repository at this point in the history
Currently, the reasoning on why each package is used

1. can be deduced from direct references in the Dockerfile (e.g. curl), or
2. can be deduced from git blame (e.g. jq: c256a30), or
3. is unclear.

To make this easier, document why each package is installed.
  • Loading branch information
victorlin authored Oct 14, 2022
1 parent 1bcd494 commit a9dd473
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ FROM python:3.7-slim-buster AS builder
SHELL ["/bin/bash", "-c"]

# Add system deps for building
# autoconf, automake: for building VCFtools; may be used by package managers to build from source
# build-essential: contains gcc, g++, make, etc. for building various tools; may be used by package managers to build from source
# ca-certificates: for secure HTTPS connections
# curl: for downloading source files
# git: for git pip installs
# jq: used in devel/latest-augur-release-tag
# pkg-config: for building VCFtools; may be used by package managers to build from source
# zlib1g-dev: for building VCFtools; may be used by package managers to build from source
# nodejs: for installing Auspice
RUN apt-get update && apt-get install -y --no-install-recommends \
autoconf \
automake \
Expand Down Expand Up @@ -191,6 +200,15 @@ RUN cd /nextstrain/auspice && npm update && npm install && npm run build && npm
FROM python:3.7-slim-buster AS final

# Add system runtime deps
# bzip2, gzip, xz-utils, zip, unzip, zstd: install compression tools
# ca-certificates: [Dockerfile] for secure HTTPS connections; may be used by workflows
# curl: [Dockerfile] for downloading binaries directly; may be used by workflows
# jq: may be used by workflows
# less: for usability in an interactive prompt
# perl: for running VCFtools
# ruby: may be used by workflows
# wget: may be used by workflows
# nodejs: for running Auspice
RUN apt-get update && apt-get install -y --no-install-recommends \
bzip2 \
ca-certificates \
Expand Down

0 comments on commit a9dd473

Please sign in to comment.