buildkite / terminal-to-html

Converts arbitrary shell output (with ANSI) into beautifully rendered HTML
http://buildkite.github.io/terminal-to-html
MIT License
642 stars 45 forks source link

Published docker image #102

Closed jkburges closed 1 year ago

jkburges commented 1 year ago

Is there a reason that there's no official docker image for this tool? That would make it easy to use on the Elastic CI stack. Otherwise, what's the recommended way for making terminal-to-html available to jobs on the Elastic CI stack?

triarius commented 1 year ago

Hi @jkburges, thanks for your interest in this tool. Usually, this is something we use internally to render the logs for a job on buildkite.com. We don't typically see people use on the Elastic CI stack, so we're curious what your use case for it is. Please let us know.

Having said that, you should be able to download the binary from the release page with commands such as:

curl -sSL https://github.com/buildkite/terminal-to-html/releases/download/v3.7.0/terminal-to-html-3.7.0-linux-amd64.gz | gunzip > terminal-to-html
chmod +x terminal-to-html
./termanal-to-html --version

And then use it in your steps.

Edit: Updated the command to download and unzip.

jkburges commented 1 year ago

We don't typically see people use on the Elastic CI stack, so we're curious what your use case for it is. Please let us know.

We use, it along with a couple of other utils, for adding terraform summaries (of what's planned to change) to the top of our builds, e.g.:

 PLAN_SUMMARY=`terraform show -json tfplan | tf-summarize | terminal-to-html`

  cat << EOF | buildkite-agent annotate --style "warning" --append --context "ctx-warn-$TERRAFORM_ENVIRONMENT"
  <details><summary class="h3">Summary</summary>
    <code><pre class="term">${PLAN_SUMMARY}</pre></code>
  </details>

you should be able to download the binary from the release page with commands such as

ok, thanks.

triarius commented 1 year ago

We use, it along with a couple of other utils, for adding terraform summaries (of what's planned to change) to the top of our builds, e.g.:

Very cool, that sound really useful! Thanks for letting us know