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

ADD: add Dev Kit to recommended extension #268

Merged
merged 3 commits into from
Sep 27, 2024

Conversation

hermanwenhe
Copy link
Contributor

Thank you for your pull request! Please provide the following information.


Change Description:

Add https://marketplace.visualstudio.com/items?itemName=msoffice.microsoft-office-add-in-debugger to extension recommendation list of templates since it's officially released.

  1. Do these changes impact any npm scripts commands (in package.json)? (e.g., running 'npm run start')
    No

  2. Do these changes impact VS Code debugging options (launch.json)?
    No

  3. Do these changes impact template output? (e.g., add/remove file, update file location, update file contents)
    No

  4. Do these changes impact documentation? (e.g., a tutorial on https://docs.microsoft.com/en-us/office/dev/add-ins/overview/office-add-ins)
    No

If you answered yes to any of these please do the following:
> Include 'Rick-Kirkham' in the review
> Make sure the README file is correct

Validation/testing performed:

Describe manual testing done. 

@hermanwenhe hermanwenhe requested a review from a team as a code owner August 28, 2024 07:31
@Rick-Kirkham
Copy link
Contributor

Must have approval from @AlexJerabek before merging.

@@ -6,7 +6,8 @@
"recommendations": [
"ms-edgedevtools.vscode-edge-devtools",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode"
"esbenp.prettier-vscode",
"msoffice.microsoft-office-add-in-debugger"
Copy link
Contributor

Choose a reason for hiding this comment

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

The microsoft-office-addin-debugger is only required for legacy Edge, and shouldn't be needed for most scenarios. So I don't know that we want to recommend it here.

@millerds

Copy link
Contributor Author

@hermanwenhe hermanwenhe Sep 2, 2024

Choose a reason for hiding this comment

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

This line is actually the Office Add-ins Development Kit. We leverage the old debugger's id so that we don't need to go through a whole review process. You can check it by click the link in PR description. @akrantz @AlexJerabek

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't believe you should be doing that. Not only is it confusing but it has the potential to bring in the old extension.

Copy link
Contributor

Choose a reason for hiding this comment

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

This line is actually the Office Add-ins Development Kit. We leverage the old debugger's id so that we don't need to go through a whole review process. You can check it by click the link in PR description. @akrantz @AlexJerabek

As I understand it, the Dev Kit is another tool for creating add-in projects. What is the reason for recommending it in templates that are used by other add-in creation tools?

Copy link
Contributor Author

@hermanwenhe hermanwenhe Sep 4, 2024

Choose a reason for hiding this comment

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

I don't believe you should be doing that. Not only is it confusing but it has the potential to bring in the old extension.

We release the Dev Kit as a new version of the old debugger. If they click the pop-up install button of recommendation extension, they would install the latest version which is the Dev Kit. Therefore, there is no chance for developers to install an old version of VSC extension unless this is what they intend to do.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Will the ID "msoffice.microsoft-office-add-in-debugger" for the Dev Kit change, or is this permanently the old name?

Choose a reason for hiding this comment

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

The Dev Kit is beyond project creation and can help developers explore more on platform capabilities. For example, they can explore samples or check the useful links in the side panel when they complete trying the first project.

Choose a reason for hiding this comment

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

The Id will not change, still "microsoft-office-add-in-debugger".

Copy link
Collaborator

@AlexJerabek AlexJerabek left a comment

Choose a reason for hiding this comment

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

I'm inclined to approve, but do we want this to be pushed to all our developers before the tool reaches GA?

@MingjiaLiu1995
Copy link

I'm inclined to approve, but do we want this to be pushed to all our developers before the tool reaches GA?

I think we can add the recommendation when the extension reaches GA for the following reasons.

  1. Hopefully the extension will also support Outlook at GA, so all WXPO developers can use it in development.
  2. By then, we complete merging sample repos and can check-in more samples for further explorations.

@millerds
Copy link
Contributor

millerds commented Sep 6, 2024

/azurepipelines run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@millerds
Copy link
Contributor

/azurepipelines run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@millerds millerds merged commit 68b680e into OfficeDev:master Sep 27, 2024
4 of 6 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.

6 participants