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.

Sign up for GitHub

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

Jump to bottom

💡 [Feature]: The Upgrade and Validate actions could return also code tour response #188

Closed
Adam-it opened this issue Mar 8, 2024 · 4 comments · Fixed by #323
Closed

💡 [Feature]: The Upgrade and Validate actions could return also code tour response #188

Adam-it opened this issue Mar 8, 2024 · 4 comments · Fixed by #323
Assignees
@nicodecleyre
Labels
⭐ enhancement New feature or request 💪 good first issue Good for newcomers 👨‍💻work in progress I am working on it
Milestone
v4.X

Comments

@Adam-it
Copy link
Member

Adam-it commented Mar 8, 2024 •
edited
Loading

🎯 Aim of the feature

As internally those actions use the project upgrade and project doctor CLI for M365 commands and those support also the tour output mode which create a code tour for the current project with the findings. We could extend those functionalities so that we return the markdown sum up report and the tour in one go.

Proposed implementation

In the CliActions service we the upgrade and validate methods. Each of those just run the CLI command under the hood with md output mode.
image

Depending on the what user have saved in the setting (see below) we should execute either the command with md or tour output or execute the commands twice with both output for both

Additional Proposal

Similar to node settings we could add additional setting for those features. For each of those features: upgrade and validate we could provide a dropdown with options that define what report type should be generated. Either: markdown (as we have now), code tour, both (which should be the default value)
image
@Adam-it Adam-it added ⭐ enhancement New feature or request ✏️prototype labels Mar 8, 2024
@Adam-it Adam-it added this to the v3.1 milestone Mar 8, 2024
@Adam-it Adam-it added 🙏 help wanted Open for contributors and removed ✏️prototype labels Apr 17, 2024
@Adam-it Adam-it added 💪 good first issue Good for newcomers 👨‍💻 CLI for Microsoft 365 Requires to first extend CLI for Microsoft 365 labels Jun 22, 2024
@nicodecleyre
Copy link
Contributor

Hi there 👋 , can i work on this one please?

@Adam-it Adam-it removed the 🙏 help wanted Open for contributors label Jun 25, 2024
@Adam-it
Copy link
Member Author

Adam-it commented Jun 25, 2024

Hi there 👋 , can i work on this one please?

Of course

@Adam-it Adam-it modified the milestones: v3.X, v4.X Sep 8, 2024
@Adam-it
Copy link
Member Author

Adam-it commented Sep 23, 2024

Hi @nicodecleyre,
Hows the work coming up with this issue?
Do you need any additional help from my side?
This year the SPFx Toolkit repo will participate in hacktoberfest and this issue will count so if you are also planning to join this event please do remember to rise a PR during October (no sooner no later 😉)
Once again thanks for taking extra interest in this product. You Rock 🤩

@nicodecleyre nicodecleyre mentioned this issue Oct 13, 2024
Merged
4 tasks
@Adam-it Adam-it added 👨‍💻work in progress I am working on it and removed hacktoberfest 👨‍💻 CLI for Microsoft 365 Requires to first extend CLI for Microsoft 365 labels Nov 17, 2024
nicodecleyre added a commit to nicodecleyre/vscode-viva that referenced this issue Nov 20, 2024
@nicodecleyre
Merge branch 'pnp:main' into Tour-response-for-Upgrade-and-Validate-p…
0615668 
…np#188
Adam-it pushed a commit that referenced this issue Nov 23, 2024
@nicodecleyre
Added tour response for Upgrade and Validate actions, Closes #188 (#323)
48c06ec 
## 🎯 Aim

Adding the tour options and both md & tour options as settings for the
upgrade and validate actions

## 📷 Result

![image](https://github.com/user-attachments/assets/582ac622-aa94-43f5-a3ae-644d24d36f17)

## ✅ What was done

- [X] Added `Md`, `Tour`, `Both` as upgrade options in the settings 
- [X] Added `Md`, `Tour`, `Both` as validate options in the settings 
- [X] Added tour logic to code for the upgrade option
- [X] Added tour logic to code for the validate option

## 🔗 Related issue

Closes: #188
@Adam-it
Copy link
Member Author

Adam-it commented Nov 23, 2024

PR merged. This will be live as a new pre-release soon.
Thank you once again for helping out in making the best SPFx tooling in the world 🚀

@Adam-it Adam-it closed this as completed Nov 23, 2024
Adam-it pushed a commit that referenced this issue Dec 10, 2024
@nicodecleyre @Adam-it
Added tour response for Upgrade and Validate actions, Closes #188 (#323)
a14e3e6 
## 🎯 Aim

Adding the tour options and both md & tour options as settings for the
upgrade and validate actions

## 📷 Result

![image](https://github.com/user-attachments/assets/582ac622-aa94-43f5-a3ae-644d24d36f17)

## ✅ What was done

- [X] Added `Md`, `Tour`, `Both` as upgrade options in the settings 
- [X] Added `Md`, `Tour`, `Both` as validate options in the settings 
- [X] Added tour logic to code for the upgrade option
- [X] Added tour logic to code for the validate option

## 🔗 Related issue

Closes: #188
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nicodecleyre nicodecleyre

Labels
⭐ enhancement New feature or request 💪 good first issue Good for newcomers 👨‍💻work in progress I am working on it
Projects
None yet
Milestone
v4.X
Development

Successfully merging a pull request may close this issue.

Added tour response for Upgrade and Validate actions, Closes #188 nicodecleyre/vscode-viva
2 participants
@nicodecleyre @Adam-it