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

Docstrings for builds #86

Open
niklas-heer opened this issue Oct 28, 2022 · 0 comments
Open

Docstrings for builds #86

niklas-heer opened this issue Oct 28, 2022 · 0 comments

Comments

@niklas-heer
Copy link
Owner

I think it would be great to have DocStrings per build so that meta information can be stored with the code.
This would also reduce drift between documentation of what is included in this speed comparison and what the different methods and approaches are.

I could see it to look like this: (using markdown syntax within)

clj-bb:
  #"""
  # builds ontop of Clojure, but uses [Babashka](https://babashka.org/) which is a Clojure interpreter with fast startup
  #"""
  FROM babashka/babashka:alpine
  DO +PREPARE_ALPINE
  DO +ADD_FILES --src="leibniz.clj"
  DO +BENCH --name="clj-bb" --lang="Clojure (Babashka)" --version="bb --version" --cmd="bb -f leibniz.clj"

Which then would be translated to a LANGUAGES.md or something in a big list with the build job name. (or the --lang="Clojure (Babashka)" parameter 🤔 )

[...]

  • clj-bb: builds ontop of Clojure, but uses Babashka which is a Clojure interpreter with fast startup

[...]

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