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

Containerize the build process and fill in developer documentation #277

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

eecavanna
Copy link

@eecavanna eecavanna commented Nov 14, 2024

In this branch, I created a Dockerfile (builder.Dockerfile) that developers can use to generate the submission schema release artifacts without installing yq (or running any non-Docker commands) on their local computer. I also documented its use, as well as documented the alternative, "direct" process of generating those release artifacts.

You can preview the documentation here: https://github.com/microbiomedata/submission-schema/blob/275-implement-a-docker-based-build-environment-for-the-submission-schema/README.md

Fixes #271

Fixes #273

Fixes #275

@eecavanna eecavanna self-assigned this Nov 14, 2024
@eecavanna
Copy link
Author

OK, I ran brew install yq and confirmed make all gets past the yq steps.

I then ran into a similar issue, where — instead of yq being missing — wget was missing. So, I installed wget via brew install wget. I'm now re-running make all.

@eecavanna
Copy link
Author

OK, I've tested these instructions and am ready for this branch to be merged into main.

@turbomam
Copy link
Member

Thanks, @eecavanna. There's some refactoring of the build process going on. Let's touch base before merging.

@eecavanna
Copy link
Author

I am wondering whether that refactoring will be done before the next release, which is currently scheduled for December 16, 2024.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants