Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added new major version v8 for CLI for M365 #1885

Merged
merged 2 commits into from
Jul 31, 2024

Conversation

arjunumenon
Copy link
Member

Category

  • Content fix
  • New article

Related issues

N/A

Contents of the Pull Request

This is a PR where we have created a PR for the new release of CLI for Microsoft 365 (v8). This will be merged only once we have the release action is completed

Copy link
Contributor

@milanholemans milanholemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done @arjunumenon! Made a few remarks while reading it.

One thing we should do: when showing command samples, we now use inline code (using single backtick). To improve the readability, I suggest we use a full line code block like we always do (using 3 backticks).

@@ -0,0 +1,170 @@
---
title: CLI for Microsoft 365 v8
date: 2024-08-01T06:00:00.000Z
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have had some issues with this date. Let's put it on July 31st somewhere in the morning to avoid issues.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree 👍. I remember solving the not published issue twice already 🙂

- CLI for Microsoft 365
- SharePoint
- SharePoint Framework (SPFx)
- Power Platform
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have to pick other tags, we haven't done much with SPFx nor Power Platform this release.


### Streamlined commands and options

Once a year we take the opportunity to look at all of the functionality that we have in the CLI and see how we can make it more consistent and intuitive. Typically, this leads to breaking changes. We've done our best to minimize the impact of these changes, but we still recommend that you review the [v8 Upgrade Guidance](https://pnp.github.io/cli-microsoft365/v8-upgrade-guidance/) in our docs to verify if you're affected by any of these changes before you upgrade to v8.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, we didn't do this in v8, this is something for v9.

Copy link
Member Author

@arjunumenon arjunumenon Jul 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. Since we do have couple of breaking changes, do you think we will give it as a section here @milanholemans?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't there already a heading talking about the breaking changes below?

Copy link
Contributor

@milanholemans milanholemans Jul 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this release we only have 2 breaking changes:

  • flow list
  • spo group member add

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I take back what I said, let us remove that section completely. For the breaking change we already have a quoted section where the end users can click and see the breaking changes. And thinking out further, it does not make much sense to add it here. So removing that section all together.


#### Breaking changes in a nutshell

The endpoint that we are using in the command `spo group member add` is changed. With this change some of the output which the command outputs is also changed. The return values changed include properties like `DisplayName`, `User`, etc. You can get more details from [here](https://pnp.github.io/cli-microsoft365/v8-upgrade-guidance#updated-command-output-of-spo-group-member-add).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The endpoint that we are using in the command `spo group member add` is changed. With this change some of the output which the command outputs is also changed. The return values changed include properties like `DisplayName`, `User`, etc. You can get more details from [here](https://pnp.github.io/cli-microsoft365/v8-upgrade-guidance#updated-command-output-of-spo-group-member-add).
The endpoint that we are using in the command `spo group member add` is changed. With this change some of the output is also changed. The return values changed include properties like `DisplayName`, `User`, etc. You can get more details from [here](https://pnp.github.io/cli-microsoft365/v8-upgrade-guidance#updated-command-output-of-spo-group-member-add).


#### Breaking changes in a nutshell

The endpoint that we are using in the command `spo group member add` is changed. With this change some of the output which the command outputs is also changed. The return values changed include properties like `DisplayName`, `User`, etc. You can get more details from [here](https://pnp.github.io/cli-microsoft365/v8-upgrade-guidance#updated-command-output-of-spo-group-member-add).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To improve clickthrough, I always recommend adding links on command names.


#### Fixed bug for CLI in Azure Cloud shell

We all have been using CLI for Microsoft 365 from Azure Cloud Shell since we will have CLI for Microsoft 365 already baked into Azure Cloud Shell. For the past week, there was an issue when we tried to run the CLI for Microsoft 365 from Azure Cloud shell. In this version, we have fixed the issue and now you can run the CLI for Microsoft 365 from Azure Cloud shell without any issues.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We all have been using CLI for Microsoft 365 from Azure Cloud Shell since we will have CLI for Microsoft 365 already baked into Azure Cloud Shell. For the past week, there was an issue when we tried to run the CLI for Microsoft 365 from Azure Cloud shell. In this version, we have fixed the issue and now you can run the CLI for Microsoft 365 from Azure Cloud shell without any issues.
CLI for Microsoft 365 has been installed by default in Azure Cloud Shell for a couple of years. For the past weeks, there was an issue when we tried to run the CLI for Microsoft 365 from Azure Cloud shell. In this version, we have fixed the issue and now you can run the CLI for Microsoft 365 from Azure Cloud shell without any issues.


#### Fixed bug when listing the flows using Admin

There was a bug when we tried to list the flows using the admin account. Now this issue is fixed and you can list the flows using the admin account without any issues. The issue was because the API that we were using was deprecated and now we have updated the command to use the new API (v2). The change also has brought in a breaking change whose details could be read from [here](https://pnp.github.io/cli-microsoft365/v8-upgrade-guidance#adjusted-output-of-flow-list-command).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this already covered above?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not exactly. Before it was added along with the breaking change. Have not given details on the changes per say.


#### Enhancement to Entra Group and Entra App commands

In this version, we have added the ability to set many more properties related to the notifications to the Entra group so that tenant admins can easily manage while using the scripts for provisioning or managing the Entra Groups.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this version, we have added the ability to set many more properties related to the notifications to the Entra group so that tenant admins can easily manage while using the scripts for provisioning or managing the Entra Groups.
In this version, we have added the ability to set many more properties related to the notifications to the Microsoft Entra group so that owners can easily manage while using the scripts for provisioning or managing the Microsoft Entra Groups.


In this version, we have added the ability to set many more properties related to the notifications to the Entra group so that tenant admins can easily manage while using the scripts for provisioning or managing the Entra Groups.

We have added the ability to remove the app permission from your Entra app even if you mention it in the scope in an unqualified way (like `Sites.Read.All` instead of `https://graph.microsoft.com/Sites.Read.All`). This will help the users to easily remove the app permission from the Entra app.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We have added the ability to remove the app permission from your Entra app even if you mention it in the scope in an unqualified way (like `Sites.Read.All` instead of `https://graph.microsoft.com/Sites.Read.All`). This will help the users to easily remove the app permission from the Entra app.
We have added the ability to remove the app permission from your Microsoft Entra app even if you mention it in the scope in an unqualified way (like `Sites.Read.All` instead of `https://graph.microsoft.com/Sites.Read.All`). This will help users easily remove app permissions from the Entra app.

Comment on lines 132 to 146
- [Adam Wójcik](https://github.com/Adam-it)
- [dojcsakj](https://github.com/dojcsakj)
- [Jasey Waegebaert](https://github.com/Jwaegebaert)
- [Martin Machacek](https://github.com/MartinM85)
- [Mathijs Verbeeck](https://github.com/MathijsVerbeeck)
- [Milan Holemans](https://github.com/milanholemans)
- [Saurabh Tripathi](https://github.com/Saurabh7019)
- [Waldek Mastykarz](https://github.com/waldekmastykarz)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Adam Wójcik](https://github.com/Adam-it)
- [dojcsakj](https://github.com/dojcsakj)
- [Jasey Waegebaert](https://github.com/Jwaegebaert)
- [Martin Machacek](https://github.com/MartinM85)
- [Mathijs Verbeeck](https://github.com/MathijsVerbeeck)
- [Milan Holemans](https://github.com/milanholemans)
- [Saurabh Tripathi](https://github.com/Saurabh7019)
- [Waldek Mastykarz](https://github.com/waldekmastykarz)
- [Adam Wójcik](https://github.com/Adam-it)
- [János Dojcsák](https://github.com/dojcsakj)
- [Jasey Waegebaert](https://github.com/Jwaegebaert)
- [Martin Machacek](https://github.com/MartinM85)
- [Mathijs Verbeeck](https://github.com/MathijsVerbeeck)
- [Milan Holemans](https://github.com/milanholemans)
- [Nello D'Andrea](https://github.com/ferrarirosso)
- [Saurabh Tripathi](https://github.com/Saurabh7019)
- [Waldek Mastykarz](https://github.com/waldekmastykarz)

Copy link
Collaborator

@Adam-it Adam-it left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arjunumenon awesome work. Actually I don't have much to add as @milanholemans covered most of the things 👏.
I have only a single suggestion that in the 'Whats Next' we could also mention the upcoming v9 which we want to release in a few months with a lot of improvements which are connected to breaking changes.
Other than that awesome work 👏👏. You should write more blog posts 😍🤩

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arjunumenon what is this and why do we need to change this?
TBH I have never updated this one 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that has something to do with FrontMatter extension which is being used. I had updated an image for the new release post. So with that, I guess the frontmatter updates the json file with the image information.
Timeline suggests that updation of the image updates this file as well.

@arjunumenon
Copy link
Member Author

Thanks @Adam-it @milanholemans for the review. I have done the modification and have given comments. Let me know if you feel any more modification on that

Copy link
Contributor

@Jwaegebaert Jwaegebaert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @arjunumenon, pardon for the late review. I've left a few comments you can take a look at. Shouldn't be anything too major.

Content types are a key feature in SharePoint that helps you to organize and manage your content in a more structured way. We already have a lot of commands for managing the content types, be it site content type or list content type.
Now we have added a new command for listing the columns/fields associated with the site and the list content types

For retrieving the fields associated with a site content type, run :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For retrieving the fields associated with a site content type, run :
For retrieving the fields associated with a site content type, run:

```


For retrieving the fields associated with a list content type in the Documents library, run :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For retrieving the fields associated with a list content type in the Documents library, run :
For retrieving the fields associated with a list content type in the Documents library, run:


### Microsoft Teams

CLI for Microsoft 365 already has a lot of commands for Managing Microsoft Teams. In this feature, we have added 2 more new commands to the existing inventory of commands.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
CLI for Microsoft 365 already has a lot of commands for Managing Microsoft Teams. In this feature, we have added 2 more new commands to the existing inventory of commands.
CLI for Microsoft 365 already has a lot of commands for managing Microsoft Teams. In this feature, we have added 2 more new commands to the existing inventory of commands.


We have added a command for [getting the attendance report](https://pnp.github.io/cli-microsoft365/cmd/teams/meeting/meeting-attendancereport-get/) of your meetings easily using a command. This is going to be super useful if you want to generate the attendance reports for your completed meetings.

For getting the specified attendance report made for the currently signed-in user and Microsoft Teams meeting with the gi, rund :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For getting the specified attendance report made for the currently signed-in user and Microsoft Teams meeting with the gi, rund :
For getting the specified attendance report made for the currently signed-in user and Microsoft Teams meeting with the given ID, run:

Comment on lines 151 to 134
We are planning to enhance the validation approach used in the codebase. Although we have a centralized validation in place, introduction to Zod would ensure the development of the commands and the validation of the inputs are more consistent and easy to maintain. We would love to hear from you if you have any suggestions. Please feel free to pitch in with your suggestions [here](https://github.com/pnp/cli-microsoft365/issues/5639).


## Contributors
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We are planning to enhance the validation approach used in the codebase. Although we have a centralized validation in place, introduction to Zod would ensure the development of the commands and the validation of the inputs are more consistent and easy to maintain. We would love to hear from you if you have any suggestions. Please feel free to pitch in with your suggestions [here](https://github.com/pnp/cli-microsoft365/issues/5639).
## Contributors
We are planning to enhance the validation approach used in the codebase. Although we have a centralized validation in place, introduction to Zod would ensure the development of the commands and the validation of the inputs are more consistent and easy to maintain. We would love to hear from you if you have any suggestions. Please feel free to pitch in with your suggestions [here](https://github.com/pnp/cli-microsoft365/issues/5639).
## Contributors

Comment on lines 166 to 148
- [Waldek Mastykarz](https://github.com/waldekmastykarz)


### High fives
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Waldek Mastykarz](https://github.com/waldekmastykarz)
### High fives
- [Waldek Mastykarz](https://github.com/waldekmastykarz)
### High fives

Comment on lines 197 to 198
If you need more help getting started or want more details about the commands, architecture, or project, go to [aka.ms/cli-m365](https://aka.ms/cli-m365). If you see any room for improvement, please, don't hesitate to reach out to us either on [Discord](https://discord.com/invite/7rfW4kg6B5), [GitHub](https://github.com/pnp/cli-microsoft365/discussions), or [X](https://twitter.com/climicrosoft365).
If you need more help getting started or want more details about the commands, architecture, or project, go to [aka.ms/cli-m365](https://aka.ms/cli-m365). If you see any room for improvement, please, don't hesitate to reach out to us either on [Discord](https://discord.com/invite/7rfW4kg6B5), [GitHub](https://github.com/pnp/cli-microsoft365/discussions), or [X](https://twitter.com/climicrosoft365).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate?

Suggested change
If you need more help getting started or want more details about the commands, architecture, or project, go to [aka.ms/cli-m365](https://aka.ms/cli-m365). If you see any room for improvement, please, don't hesitate to reach out to us either on [Discord](https://discord.com/invite/7rfW4kg6B5), [GitHub](https://github.com/pnp/cli-microsoft365/discussions), or [X](https://twitter.com/climicrosoft365).
If you need more help getting started or want more details about the commands, architecture, or project, go to [aka.ms/cli-m365](https://aka.ms/cli-m365). If you see any room for improvement, please, don't hesitate to reach out to us either on [Discord](https://discord.com/invite/7rfW4kg6B5), [GitHub](https://github.com/pnp/cli-microsoft365/discussions), or [X](https://twitter.com/climicrosoft365).
If you need more help getting started or want more details about the commands, architecture, or project, go to [aka.ms/cli-m365](https://aka.ms/cli-m365). If you see any room for improvement, please, don't hesitate to reach out to us either on [Discord](https://discord.com/invite/7rfW4kg6B5), [GitHub](https://github.com/pnp/cli-microsoft365/discussions), or [X](https://twitter.com/climicrosoft365).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops

@@ -1 +1 @@
{"users":{"luise":{"onedrive":{"dev":{"pnpblog":{"content":{"weekly-agenda":{"23-09-11":{"images":{"weeklyagenda37.png":{}}},"23-09-18":{"images":{"weeklyagenda38.png":{}}},"23-10-16":{"images":{}},"23-10-23":{"images":{}},"23-10-30":{"images":{}},"23-11-06":{"images":{}},"23-11-13":{"images":{}},"23-11-20":{"images":{}},"23-11-27":{"images":{}},"23-12-04":{"images":{}},"23-12-11":{"images":{}},"23-12-18":{"images":{}},"23-12-25":{"images":{}},"24-01-01":{"images":{}},"24-01-08":{"images":{}},"24-01-15":{"images":{}},"24-01-22":{"images":{}},"24-01-29":{"images":{}},"24-02-05":{"images":{}},"24-02-12":{"images":{}},"24-02-19":{"images":{}},"24-02-26":{"images":{}},"24-03-04":{"images":{}},"24-03-11":{"images":{}},"24-03-18":{"images":{}},"24-03-25":{"images":{}},"24-04-01":{"images":{}},"24-04-08":{"images":{}},"24-04-15":{"images":{}},"24-04-22":{"images":{}},"24-04-29":{"images":{}},"24-05-06":{"images":{}},"24-05-13":{"images":{}},"24-05-20":{"images":{}},"24-05-27":{"images":{}},"24-06-03":{"images":{}},"24-06-10":{"images":{}},"24-06-24":{"images":{}},"24-07-01":{"images":{}},"24-07-08":{"images":{}},"24-07-15":{"images":{}},"24-07-22":{"images":{}},"24-07-29":{"images":{}}}}}}}}}}
{"users":{"luise":{"onedrive":{"dev":{"pnpblog":{"content":{"weekly-agenda":{"23-09-11":{"images":{"weeklyagenda37.png":{}}},"23-09-18":{"images":{"weeklyagenda38.png":{}}},"23-10-16":{"images":{}},"23-10-23":{"images":{}},"23-10-30":{"images":{}},"23-11-06":{"images":{}},"23-11-13":{"images":{}},"23-11-20":{"images":{}},"23-11-27":{"images":{}},"23-12-04":{"images":{}},"23-12-11":{"images":{}},"23-12-18":{"images":{}},"23-12-25":{"images":{}},"24-01-01":{"images":{}},"24-01-08":{"images":{}},"24-01-15":{"images":{}},"24-01-22":{"images":{}},"24-01-29":{"images":{}},"24-02-05":{"images":{}},"24-02-12":{"images":{}},"24-02-19":{"images":{}},"24-02-26":{"images":{}},"24-03-04":{"images":{}},"24-03-11":{"images":{}},"24-03-18":{"images":{}},"24-03-25":{"images":{}},"24-04-01":{"images":{}},"24-04-08":{"images":{}},"24-04-15":{"images":{}},"24-04-22":{"images":{}},"24-04-29":{"images":{}},"24-05-06":{"images":{}},"24-05-13":{"images":{}},"24-05-20":{"images":{}},"24-05-27":{"images":{}},"24-06-03":{"images":{}},"24-06-10":{"images":{}},"24-06-24":{"images":{}},"24-07-01":{"images":{}},"24-07-08":{"images":{}},"24-07-15":{"images":{}},"24-07-22":{"images":{}},"24-07-29":{"images":{}}}}}}}}},"content":{"cli-for-microsoft-365":{"cli-for-microsoft-365-v8-0":{"images":{}}}}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit curious, what does this mediaDb.json do exactly?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is a Frontmatter file which keeps the metadata associated when you add an image to the project. In this case, I had added a new image and that is why this file has got changed. You can see this issue which is there in FrontMatter issue list where folks explain about that

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small detail but looks like our asciinemaplayer is missing here. This does seem to be a more common issue that it doesn't render anymore on the initial load. 😐

Copy link
Member Author

@arjunumenon arjunumenon Jul 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is a nice find. I had not noticed that...

I think you are right. It is not getting loaded for me somehow. Tried in various browsers and VMs. Guess we need to raise an issue in the repo. I will initiate it. Thanks for the find .👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can easily fix this issue by clicking on a link to another page and clicking "home" again.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somehow I am still facing an issue. Now instead of a no image, I am getting a black block. Let us troubleshoot in the issue which we have opened and see that.

image

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to fixup this screenshot before merge?

@Adam-it Adam-it merged commit c7e9c48 into pnp:main Jul 31, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants