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

Add documentation, Github Action for Dockerfile #215

Closed
1 of 2 tasks
BSchilperoort opened this issue Jan 3, 2024 · 1 comment · Fixed by #264
Closed
1 of 2 tasks

Add documentation, Github Action for Dockerfile #215

BSchilperoort opened this issue Jan 3, 2024 · 1 comment · Fixed by #264
Labels
documentation Improvements or additions to documentation

Comments

@BSchilperoort
Copy link
Contributor

BSchilperoort commented Jan 3, 2024

PR #214 adds a dockerfile. No documentation for users on how to run this (instead of the executable directly) is available yet.

We will have to document:

  • How to build the image locally
  • How to run the image and mount directories

Additionally, a Github Action can be set up that will build and publish a new version of the docker image when a release is made on this repository. This will make it easier and less work to keep the Docker image in sync with the code.

@SarahAlidoost SarahAlidoost added the documentation Improvements or additions to documentation label Mar 1, 2024
@BSchilperoort
Copy link
Contributor Author

The Docker image is now automagically built and pushed when a release is made

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants