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

mdx docker codeblock #116

Open
avsm opened this issue Mar 29, 2019 · 2 comments
Open

mdx docker codeblock #116

avsm opened this issue Mar 29, 2019 · 2 comments
Labels
Kind/Feature-request New feature or request

Comments

@avsm
Copy link
Member

avsm commented Mar 29, 2019

I'd like to have installation instructions run "live", so that we can regression test our installation instructions in RWO and ocaml.org.

For that, we would need to have some way to redirect a codeblock into docker. E.g. something like:

# apk add --update opam
# opam init -ya
# opam install rwo

And have that execute the commands and fill them in.

@Julow
Copy link
Collaborator

Julow commented Jun 28, 2019

The use case is to test their output only ?
Or should it be able to run commands in an other block in the same environment ?
Or even OCaml code ? (This requires a lot of work)

Also, downloading an image and initializing opam will take a very long time and commands that can run automatically may be different than commands run by users. (eg. -y --quiet)
So if this is the main use case, wouldn't it be better to test that somewhere else than in the build of rwo ? (Eg. in a global CI run for every ocaml releases)

@avsm
Copy link
Member Author

avsm commented Jun 30, 2019

All good questions -- I had in mind that this would run less often than other tests. It would be useful to be able to classify some mdx blocks with a tag, and only run those tags (e.g. this could be an install tag in the block).

The usecase is to test their output only. We have installation instructions for >10 distros now, so automating it is extremely useful, especially to see when they start failing. The output could be considered nondeterministic, as with benchmarks.

@gpetiot gpetiot added the Kind/Feature-request New feature or request label Mar 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Kind/Feature-request New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants