How to determine if in dryRun from plugin code

[pbrisbin]

I'm working on a plugin in which I want to do something conditionally in the verify step, iff we're in dryRun.

Based on the types definition, it looks like Options has the dryRun attribute I'd need. And based on the implementation of run, it looks like the context passed to verify has an options attribute. However, none of the context interfaces define that options attribute, which I assume is why my editor doesn't like me trying to use it in type script...

Do I have all that right? Is that a bug in the type definition? Or an intentional omission in the public API? What is the recommended way for a plugin to know if it's being executed in dryRun mode?

[babblebey]

What is the recommended way for a plugin to know if it's being executed in dryRun mode?

Hi @pbrisbin, I will answer this particular question by saying you can either imply or confirm.. i.e. you can guess whether the plug-in is running in dry mode by working like this

semantic-release/index.js

Line 43 in f15019c

if (!isCi && !options.dryRun && !options.noCi) {

Or you can confirm by seeing if options.dryRun is true.

All routes basically leads through the context.options as that is a collection of running conditions of the release process to begin with.

Do I have all that right? Is that a bug in the type definition? Or an intentional omission in the public API?

You do have things right, but I cannot exactly say that there's a bug in type definition. I'd leave this to @travi to help us understand the thoughts behind the omission of options in the BaseContext type definition.

[travi]

I cannot exactly say that there's a bug in type definition. I'd leave this to @travi to help us understand the thoughts behind the omission of options in the BaseContext type definition.

i fully admit that i am not a typescript developer. these are the types of questions that made me hesitant to add a type definition even when we did. we are open to contributions to update if there are legitimate gaps or inaccuracies in the definition that we provide. cc @seebeen could you help with this?

[seebeen]

It seems the typedef is a bit out of date, and is missing some things.

I'll update the definition to be in sync with v24 ASAP.

Nice catch @pbrisbin 💪

[seebeen]

@babblebey Typescript definitions were written for v21 to support the development of the wordpress plugin.

They were ported to the main repository later.

I'll find some time next week and recheck the entire typedef and add some tests for it.

[github-actions]

🎉 This issue has been resolved in version 24.2.3 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀