Stability(3)

📦
version 2013 · 14 versions
, in opensuse-leap 16.0

💅 Canary::Stability — the vibe check for your perl 💅

So like, the manual page for Stability(3) lives in the User Contributed Perl Documentation section, and honestly? It's giving "small module, big feelings." Let's get into it bestie. 🎀

✨ NAME ✨

Canary::Stability — a literal canary 🐤 that checks whether your perl is even compatible with schmorp's modules. No cap.

🌸 SYNOPSIS 🌸

# in Makefile.PL
use Canary::Stability DISTNAME => 2001, MINIMUM_PERL_VERSION;

That's it. That's the whole API. Iconic, honestly. 💅

🦋 DESCRIPTION 🦋

Okay so here's the tea ☕: Schmorp's modules use this during the configuration stage to test the perl you've got installed and see if it's compatible with his modules. That's the whole job. It's a canary in a coal mine, but make it perl. 🐤

At this stage, it is not meant as a tool for other module authors — like, it's not built for you to adopt, bestie. However, in principle nothing stops anyone from subscribing to the same ideas. The door's unlocked, it's just not, like, an invitation. 🙈

Wanna see it in the wild? Peep the Makefile.PL in Coro or AnyEvent for usage examples. Go look, it's right there, iykyk. 👀

🌈 ENVIRONMENT VARIABLES 🌈

These little guys control the whole mood. Memorize them fr fr.

  • PERL_CANARY_STABILITY_NOPROMPT=1 — do not prompt the user on alert messages. Just... no pop-ups. Silence. Peace. 🕊️
  • PERL_CANARY_STABILITY_COLOUR=0 — disable use of colour. For when you want the raw, unseasoned experience. 🍚
  • PERL_CANARY_STABILITY_COLOUR=1 — force use of colour. Even when it shouldn't. Especially when it shouldn't. 🌈✨
  • PERL_CANARY_STABILITY_DISABLE=1 — disable this module's functionality completely. Nuclear option. The module doesn't exist to you anymore. 💀
  • AUTOMATED_TESTING=1 — so when this bad boy is set to a true value and the perl minimum version requirement is not met? The module will exit, which should skip testing under automated testing environments. 🚪💨
Okay, why tho? 👇

This is done to avoid false failure or false success reports when the chances of success are already quite low — and the failures are not supported by the author. Like, if it's already doomed, why generate confusing paperwork about it? Exactly. 🙅‍♀️

👑 AUTHOR 👑

Marc Lehmann <schmorp@schmorp.de> 💌

http://software.schmorp.de/pkg/Canary-Stability.html 🌐

And that's the whole thing! Written and shipped in the world of perl v5.42.0, dated 2019-04-23 — so like, this page has been serving looks since 2019 and it's still eating. 🍓 Thanks for coming to my Ted Talk, mwah. 🫶✨

📦 where this page comes from