I’m trying to provide example usage of an orb, but the example that ends up in the Orb repository is different to how I formatted it.
You can see that it’s converted the multi-line JSON string into a single line, full of newline escapes, which is completely unreadable, and changes the example from being a good example to a bad one.
The strange thing is, the same thing doesn’t seem to happen for a similar official orb.
I inspected the
circleci/slack orb source with
circleci orb source email@example.com and tried a couple of things based on that:
- Indenting with 4 spaces instead of 2
- Using tabs inside the json instead of spaces
But no luck.
Does anybody have any ideas?