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 component governance file #6166

Merged
merged 2 commits into from
Jun 7, 2021
Merged

add component governance file #6166

merged 2 commits into from
Jun 7, 2021

Conversation

DavidKutu
Copy link

This is the new way of registering components.

More info here: https://docs.opensource.microsoft.com/tools/cg/features/cgmanifest/

  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR).
  • Title summarizes what is changing.
  • Has a news entry file (remember to thank yourself!).
  • Appropriate comments and documentation strings in the code.
  • Has sufficient logging.
  • Has telemetry for enhancements.
  • Unit tests & system/integration tests are added/updated.
  • Test plan is updated as appropriate.
  • package-lock.json has been regenerated by running npm install (if dependencies have changed).

@DavidKutu DavidKutu requested a review from a team as a code owner June 7, 2021 17:20
cgmanifest.json Outdated
},
{
"Component": {
"Npm": {
Copy link
Contributor

Choose a reason for hiding this comment

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

How come the npm dependencies aren't picked up by our package.json?

Copy link
Author

Choose a reason for hiding this comment

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

Those are the alerts found here:
https://dev.azure.com/vscode-python-datascience/vscode-python-datascience/_componentGovernance/18591?_a=alerts&typeId=133049&alerts-view-option=active

I'm not sure why they aren't picked up automatically. Before you registered them right there, but now they're asking for repos to have that file.

The python repo also has it.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm confused. They look like they are picked up to me. Otherwise how does the warning show up. I don't think this is going to fix the governance errors. You need to update our package.json to newer versions to update them.

@IanMatthewHuff
Copy link
Member

Interesting, so this replaces the process on the website that wasn't working anymore? I see this cgmanifest in the python extension already.

@DavidKutu
Copy link
Author

@IanMatthewHuff yes

Copy link
Contributor

@rchiodo rchiodo left a comment

Choose a reason for hiding this comment

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

⏲️

@rchiodo
Copy link
Contributor

rchiodo commented Jun 7, 2021

The guidance for the file you added was for dependencies that can't be picked up elsewhere:

A cgmanifest file is a json file used to register components manually when the component type is not supported by governance.

@DavidKutu
Copy link
Author

@rchiodo they asked me to do it like this: https://mseng.visualstudio.com/AzureDevOps/_workitems/edit/1849128

@DavidKutu DavidKutu requested a review from rchiodo June 7, 2021 17:46
@DavidKutu DavidKutu merged commit 83b0d39 into release-2021.06 Jun 7, 2021
@DavidKutu DavidKutu deleted the david/CGmanifest branch June 7, 2021 18:41
DavidKutu pushed a commit that referenced this pull request Jun 8, 2021
* release candidate (#6059)

* release candidate

* Memorial Day API changes (#6056)

* update changelog

Co-authored-by: Ian Huff <ianhu@microsoft.com>

* Memorial Day API changes (#6056)

* Send only error type in reason (#6067)

* Fallback for sys.prefix not being returned by Python extension (#6053)

* Fixes to toggling output (#6068)

* Better telemetry when we don't find a matching kernel (#6060)

* Better data when fail to find kernel connection (#6070)

* change version and API port (#6085)

* change version to 2021.6.x

* match packagejson and changelog versions

* 6/2 API Changes (#6089)

Co-authored-by: Ian Huff <ianhu@microsoft.com>

* Port #6025 to release (#6103)

* Remove our Run Above/Below commands (#6026)

* Update changelog

* Fix pervasive test issue with editor properties (#6100) (#6106)

* update version to 2021.6.99 to be able to filter (#6122)

* update version to 2021.6.99 to be able to filter
update changelog

* update package lock and VSCode api

* don

* remove api changes in the code

* Port Don's fixes (#6115)

* Fix test failures resulting from VSCodes Notebook Start page (#6111)

* Disable kernel auto startup in untrusted workspace (#6088)

* Disable kernel auto startup in untrusted workspace

* Fixes

* Misc

* oops

* misc

* Fixes to breaking tests (#6074)

Co-authored-by: Don Jayamanne <don.jayamanne@outlook.com>

* Breaking changes ports to release (2 commits) (#6140)

* add component governance file (#6166)

* add component governance file

* remove npm components

* Cherry pick changes from main branch into release (#6174)

* final update (#6176)

* final update

* update changelog

* update verion, engine
revert change on gulpfile

* merge main

* revert engine to 1.57-insider

* delete news files that are on the changelog

* disable insiders build

Co-authored-by: Ian Huff <ianhu@microsoft.com>
Co-authored-by: Don Jayamanne <don.jayamanne@yahoo.com>
Co-authored-by: Don Jayamanne <don.jayamanne@outlook.com>
Co-authored-by: Joyce Er <joyceerhuiling@gmail.com>
DavidKutu pushed a commit that referenced this pull request Jun 10, 2021
* release candidate (#6059)

* release candidate

* Memorial Day API changes (#6056)

* update changelog

Co-authored-by: Ian Huff <ianhu@microsoft.com>

* Memorial Day API changes (#6056)

* Send only error type in reason (#6067)

* Fallback for sys.prefix not being returned by Python extension (#6053)

* Fixes to toggling output (#6068)

* Better telemetry when we don't find a matching kernel (#6060)

* Better data when fail to find kernel connection (#6070)

* change version and API port (#6085)

* change version to 2021.6.x

* match packagejson and changelog versions

* 6/2 API Changes (#6089)

Co-authored-by: Ian Huff <ianhu@microsoft.com>

* Port #6025 to release (#6103)

* Remove our Run Above/Below commands (#6026)

* Update changelog

* Fix pervasive test issue with editor properties (#6100) (#6106)

* update version to 2021.6.99 to be able to filter (#6122)

* update version to 2021.6.99 to be able to filter
update changelog

* update package lock and VSCode api

* don

* remove api changes in the code

* Port Don's fixes (#6115)

* Fix test failures resulting from VSCodes Notebook Start page (#6111)

* Disable kernel auto startup in untrusted workspace (#6088)

* Disable kernel auto startup in untrusted workspace

* Fixes

* Misc

* oops

* misc

* Fixes to breaking tests (#6074)

Co-authored-by: Don Jayamanne <don.jayamanne@outlook.com>

* Breaking changes ports to release (2 commits) (#6140)

* add component governance file (#6166)

* add component governance file

* remove npm components

* Cherry pick changes from main branch into release (#6174)

* final update (#6176)

* final update

* update changelog

* add missing thanks to changelog (#6197)

* Skip uploading vsix to azure blob store (#6204)

* publish release

* publish release

* remove last 2 numbers from release (#6219)

* publish release

* fix conflicts

* update engine to 1.58.0-insider

* return engine version to 1.57.0-insider

* Do not activate Python before opening nb (#6201) (#6230)

* publish release

Co-authored-by: Ian Huff <ianhu@microsoft.com>
Co-authored-by: Don Jayamanne <don.jayamanne@yahoo.com>
Co-authored-by: Don Jayamanne <don.jayamanne@outlook.com>
Co-authored-by: Joyce Er <joyceerhuiling@gmail.com>
DavidKutu pushed a commit that referenced this pull request Jun 16, 2021
* release candidate (#6059)

* release candidate

* Memorial Day API changes (#6056)

* update changelog

Co-authored-by: Ian Huff <ianhu@microsoft.com>

* Memorial Day API changes (#6056)

* Send only error type in reason (#6067)

* Fallback for sys.prefix not being returned by Python extension (#6053)

* Fixes to toggling output (#6068)

* Better telemetry when we don't find a matching kernel (#6060)

* Better data when fail to find kernel connection (#6070)

* change version and API port (#6085)

* change version to 2021.6.x

* match packagejson and changelog versions

* 6/2 API Changes (#6089)

Co-authored-by: Ian Huff <ianhu@microsoft.com>

* Port #6025 to release (#6103)

* Remove our Run Above/Below commands (#6026)

* Update changelog

* Fix pervasive test issue with editor properties (#6100) (#6106)

* update version to 2021.6.99 to be able to filter (#6122)

* update version to 2021.6.99 to be able to filter
update changelog

* update package lock and VSCode api

* don

* remove api changes in the code

* Port Don's fixes (#6115)

* Fix test failures resulting from VSCodes Notebook Start page (#6111)

* Disable kernel auto startup in untrusted workspace (#6088)

* Disable kernel auto startup in untrusted workspace

* Fixes

* Misc

* oops

* misc

* Fixes to breaking tests (#6074)

Co-authored-by: Don Jayamanne <don.jayamanne@outlook.com>

* Breaking changes ports to release (2 commits) (#6140)

* add component governance file (#6166)

* add component governance file

* remove npm components

* Cherry pick changes from main branch into release (#6174)

* final update (#6176)

* final update

* update changelog

* add missing thanks to changelog (#6197)

* Skip uploading vsix to azure blob store (#6204)

* publish release

* publish release

* remove last 2 numbers from release (#6219)

* publish release

* Do not activate Python before opening nb (#6201) (#6230)

* publish release

* Port LiveKernelModel fix to release for point release (#6264)

* Port keybinding updates to release (#6268)

* Contribute shift+enter, ctrl+enter, L, shift+L (#6205)

* Ctrl+Enter should put cell into command mode after executing (#6231)

* Update CHANGELOG and remove news

* port test fix (#6275)

* Fix Restarting kernel... test (#6267)

* wait for the restart command

* add news file

* update changelog

* Fix native notebook interrupt toolbar (#6280) (#6282)

* update changelog (#6284)

* -update version
-update changelog

* leave version as it was

* Respect jupyter.enableKeyboardShortcuts setting and enable ctrl+enter in command mode (#6293)

* publish release

* fix gulpfile

* undo change

Co-authored-by: Ian Huff <ianhu@microsoft.com>
Co-authored-by: Don Jayamanne <don.jayamanne@yahoo.com>
Co-authored-by: Don Jayamanne <don.jayamanne@outlook.com>
Co-authored-by: Joyce Er <joyceerhuiling@gmail.com>
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.

3 participants