cli-microsoft365 icon indicating copy to clipboard operation
cli-microsoft365 copied to clipboard

Script samples could also show CLI version

Open Adam-it opened this issue 1 year ago • 4 comments

Currently, in our docs we do not show which version of CLI was used when some script was written. image

This may lead to problems when someone tries one of our scripts with latest version of CLI. Some things could already changed and some options could already be deprecated. Of course it would be best if we would keep our scripts inline with latest major version but it is a lot of work and we may still just miss something.

in the Microsoft Adoption sample gallery this info is shown

image

It's kept in the sample.json in which we store all sample metadata image

It would be best if we could also show this on our docs also coming from the sample.json asset so we won't need to maintain the version in two places.

Adam-it avatar Aug 11 '24 20:08 Adam-it

@pnp/cli-for-microsoft-365-maintainers any feed on this? What is your take?

Adam-it avatar Aug 11 '24 20:08 Adam-it

Seems like a good addition. On the other hand, our script samples should always work with the latest version of CLI. Unfortunately I know this is sometimes overlooked by us.

milanholemans avatar Aug 11 '24 20:08 milanholemans

Sounds like a good idea! That would make it a bit easier to use for folks.

Jwaegebaert avatar Aug 13 '24 07:08 Jwaegebaert

Seems like a good addition. On the other hand, our script samples should always work with the latest version of CLI. Unfortunately I know this is sometimes overlooked by us.

I think the problem is when you're on an older CLI version than the one used to build the script.

waldekmastykarz avatar Aug 20 '24 07:08 waldekmastykarz