alabaster icon indicating copy to clipboard operation
alabaster copied to clipboard

[BUG FIX] Enable alabaster render Travis CI badges for .com

Open webknjaz opened this issue 6 years ago • 9 comments

Fixes #145

UPD: If somebody is looking to monkey-patch
it in their project while this isn't
merged — just apply this 👇

                https://github.com/sanitizers/octomachinery/commit/e5756d9ad21cb77ed138bcf865eea0eb9efcd03b

webknjaz avatar Dec 17 '18 15:12 webknjaz

Super appreciate you taking the initiative on this! 👍 Immediate feedback:

  • I'm not sure I like the "auto" option, even though I am sure it took most of your time to get it working! Argh.
    • I totally get why it's tempting, but my inner sysadmin cringes at the idea of adding an additional HTTP request cycle to every doc build, with all that it entails: extra time/latency, tying ability to get docs built to another service's availability, etc. Yes, even though it's opt-in.
    • It's also a nontrivial addition of potential bug surface area, and I can speak from experience there. This is gonna have or grow bugs and that's more bug reports. I'm skeptical that the convenience is worth the cost, over time.
    • Minor vs the above two, but: users lacking requests (they exist! 😱) will have this blow up on them (not at import time, because you did guard against that, but when they actually flip their setting to auto). Documenting it could help, but either way it's still friction.
  • I'd be way more comfortable with travis_tld being a simple "set to com or org", which if I squint, is already in here...
    • maybe include the dot, too – I feel like the average user "thinks in" TLDs as being "dot-whatever"? so travis_tld = ".com". Maybe this is a better spot for magic/convenience: just do .lstrip('.') in case the user did supply it. EDIT: er, right, except without the context stuff we're left to Jinja. Pretty sure it has strip filters though.
  • Our own docs need to mention the new option! ✍️

bitprophet avatar Dec 18 '18 02:12 bitprophet

Fair enough. I can drop autodetection for now and will try to add some docs on that.

webknjaz avatar Dec 20 '18 12:12 webknjaz

Oh, and I'd add that .com. is also valid but probably the average user doesn't know about it :) Still I'd strip dots on both sides of the string.

webknjaz avatar Dec 20 '18 12:12 webknjaz

If somebody is looking to monkey-patch it in their project — just apply this 👇

                https://github.com/sanitizers/octomachinery/commit/e5756d9ad21cb77ed138bcf865eea0eb9efcd03b

webknjaz avatar Jul 07 '19 09:07 webknjaz

@bitprophet bump :alarm_clock:

webknjaz avatar Oct 20 '19 13:10 webknjaz

Any update on this? Travis started allowing automatic migration a while ago

CraftSpider avatar Jul 11 '20 00:07 CraftSpider

any chance on getting this merged soon? as of June 15, 2021, the travis-ci.org site is essentially dead, so the existing Travis badge feature can't even work for holdouts.

ajyoon avatar Sep 14 '21 03:09 ajyoon

At this point since org is dead I'd rather just change the existing code to s/org/com/ - is there any reason not to do so? I haven't dug into the rest of what this does though - if it adds additional value on top, then maybe just slimming this one down so it doesn't do the "tld setting" stuff would be fine.

bitprophet avatar Oct 01 '21 16:10 bitprophet

Dunno, I don't think I use the theme anymore, or Travis for that matter. It should be fine to just replace with .com tho. OTOH it's probably more important to add support for the GHA badges these days.

webknjaz avatar Oct 01 '21 19:10 webknjaz