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

Annotate package installs #93

Merged
merged 3 commits into from
Oct 17, 2022
Merged

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Oct 13, 2022

Description of proposed changes

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.

Related issue(s)

N/A

Testing

  • Checks pass

@victorlin victorlin self-assigned this Oct 13, 2022
@victorlin victorlin force-pushed the victorlin/annotate-package-installs branch from 4377527 to aebb34a Compare October 13, 2022 18:13
Copy link
Member Author

@victorlin victorlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've filled out what I could find through a quick search. There's still some missing things which I've tagged others to help on.

Dockerfile Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
Upon removing libpng-dev, the build error from VCFtools is:

    No package 'zlib' found

libpng-dev also installs zlib1g-dev as a dependency, which is why that
worked. The build succeeds if zlib1g-dev is installed directly, so do
that to avoid unnecessary installs.
The build succeeds without this installed. It was likely used at some
point since added in 3917c1b, but
building from that commit no longer works due to changes in upstream URL
availability. I did not dig deeper to find out exactly where it was used.
@victorlin victorlin force-pushed the victorlin/annotate-package-installs branch from aebb34a to a9dd473 Compare October 14, 2022 17:58
@victorlin victorlin marked this pull request as ready for review October 14, 2022 18:08
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.
@victorlin victorlin force-pushed the victorlin/annotate-package-installs branch from a9dd473 to 10ecb42 Compare October 17, 2022 17:28
@tsibley
Copy link
Member

tsibley commented Oct 17, 2022

Great to have this documentation!

@victorlin victorlin merged commit 6b49a19 into master Oct 17, 2022
@victorlin victorlin deleted the victorlin/annotate-package-installs branch October 17, 2022 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants