question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve the comment watermark format

See original GitHub issue

Watermarks are invisible strings inserted on CML comments[^1] so they can be differentiated from comments created by users. Our current watermark format is all but uniquely identifiable, and should probably be updated.

https://github.com/iterative/cml/blob/7bd925718ca2f1abb8d484fdd551a38683eb5cd3/src/cml.js#L181

Note that watermarks use a blank image instead of an HTML comment, because not all forges support the latter in their respective flavours of Markdown.

Proposal

Use the image description to store arbitrary data encoded as Base64 (e.g. useful for live metrics) and the image link to point to an invisible, tiny image in a static host of our choice.

![eyJrZXkiOiAidmFsdWUifQ==](https://cml.dev/9b0e332381649d87112c181dae1568640ea055b3100e5253d86410d276db8af9/pixel.gif) 

Precursors

[^1]: E.g. created by running cml send-comment

Issue Analytics

  • State:open
  • Created a year ago
  • Reactions:2
  • Comments:14 (14 by maintainers)

github_iconTop GitHub Comments

1reaction
casperdclcommented, Sep 26, 2022
  1. poor rendering: could this be fixed by using PNG instead of SVG?
  2. poor URL: I’d be fine with replacing raw.githubusercontent.com/iterative/cml/master/assets -> static.iterative.ai/cml
  3. guaranteeing no hidden tracking: the above (static.iterative.ai) is open sourced at https://github.com/iterative/static to prove no nefarious activity
  4. base64: why? what is the use case? What metadata do we actually need to inject? If it’s just a comment ID then plaintext | urllib.parse.quote is enough?
Read more comments on GitHub >

github_iconTop Results From Across the Web

Insert a watermark - Microsoft Support
On the Design tab, select Watermark. · Choose a pre-configured watermark, like DRAFT, CONFIDENTIAL, or DO NOT COPY. · For placing a logo...
Read more >
How to Insert and Modify Image Watermarks in Microsoft Word
Learn how to insert, modify, and delete image watermarks in Microsoft Word. Image watermarks can be logos, pictures, or graphics used for ...
Read more >
How to edit watermark in Word - YouTube
Whenever we need to edit an existing watermark, such as change the text color or make the font size bigger, our first impulse...
Read more >
Add watermarks to PDFs in Adobe Acrobat
To use an image as a watermark, select File. Then click Browse and select the image file. If the file has multiple pages...
Read more >
How to Make Sharp Watermarks in Lightroom - Photography Life
You can use “Text” and simply type the character that holds your watermark. Since fonts are vector-based, increasing or decreasing font size ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found