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

Docker image for a reproducible environment #220

Open
mortenpi opened this issue Jan 26, 2024 · 0 comments
Open

Docker image for a reproducible environment #220

mortenpi opened this issue Jan 26, 2024 · 0 comments

Comments

@mortenpi
Copy link
Member

mortenpi commented Jan 26, 2024

We should create and publish a standard Docker-based environment in which the users can execute their documentation builds. This would hopefully mean that any issues that DocumentationGenerator encounters could easily be reproduced by anyone. It could also perhaps be reused in package CI.

One small question mark is whether this should be a Docker image which wraps around DocumentationGenerator, or a Docker image that DocumentationGenerator calls. The latter would mean that there would be a Julia interface for executing the Docker image, but would add a Docker dependency to the package (probably would cause issues if you want to run it on Windows for example; it could be opt-in though). But if it's opt-in anyway, it might be easier to just go with the former option, where the Docker image is just a command line interface to the package. The package could also be called in other environments, but for reproducibility it would be best to call the package with the standard Docker image.

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

No branches or pull requests

1 participant