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

Board Review: Management Plane Namespace Review Azure.TrustedSigning #7099

Closed
ashutak84 opened this issue Jan 9, 2024 · 14 comments
Closed
Assignees
Labels
architecture board-review Request for an Architectural Board Review mgmt-namespace-ready Approve the namespace review request of mgmt plan SDK mgmt-namespace-review requests for namespace reviews of mgmt plane SDKs

Comments

@ashutak84
Copy link

ashutak84 commented Jan 9, 2024

Thank you for submitting this review request. Thorough review of your management library namespaces ensures that your library names are consistent with the guidelines and the consumers of your management library have a consistently good experience when using Azure.

To ensure consistency, all language library names will generally be reviewed together.

Before submitting, ensure you adjust the title of the issue appropriately.

Note that the required material must be included before a meeting can be scheduled.

Contacts and Timeline

Responsible service team: Azure Code Signing
Main contacts: ashuku@microsoft.com, rakiasegev@microsoft.com, meha.sharma@microsoft.com, Amrita.Shanbhag@microsoft.com
Expected code complete date: Feb 20, 2024
Expected release date: April 1st, 2024

About the Service (required)

Namespace Proposals (required per language)

  • .NET: Azure.ResourceManager.TrustedSigning
  • Java: azure-resourcemanager-trustedsigning(com.azure.resourcemanager.trustedsigning)
  • Go/Golang: sdk/resourcemanager/trustedsigning/armtrustedsigning
  • JavaScript: @azure/arm-trustedsigning
  • Python: azure-mgmt-trustedsigning

Thank you!

@ashutak84 ashutak84 added architecture board-review Request for an Architectural Board Review mgmt-namespace-review requests for namespace reviews of mgmt plane SDKs labels Jan 9, 2024
@ronniegeraghty
Copy link
Member

Pinging here again to add the namespaces for the other languages

@ronniegeraghty
Copy link
Member

@ashutak84
Pinging here again. Please add the namespaces for the other languages. If there is no update in a week, I'll close this issue out.

@ronniegeraghty
Copy link
Member

Closing this issue as there has been no response from review requester. No namespaces have been approved.

@ashutak84
Copy link
Author

Could you please reopen this one. I think my comments were there at the bottom, but i missed to update each namespace there.

@ArthurMa1978
Copy link
Member

According to the description of the service, the namespace should be:

  • .NET: Azure.ResourceManager.CodeSigning
  • Java: azure-resourcemanager-codesigning (com.azure.resourcemanager.codesigning)
  • Go/Golang: sdk/resourcemanager/codesigning/armcodesigning
  • JavaScript: @azure/arm-codesigning
  • Python: azure-mgmt-codesigning

@ashutak84
Copy link
Author

Hi Arthur, thanks for taking a look at it, the one in the comments are the latest and the approved ones from our PMs, i have updated the description accordingly.

@ronniegeraghty
Copy link
Member

@ashutak84,
The namespaces in the description of the issue break a few of our naming rules.
Rules to follow:

  • Azure should not be repeated in the namespace. Azure is already at the beginning of every namespace and does not need to be repeated.
  • microsoft should not be included in the naming as Azure is a known brand of Microsoft and including microsoft in the naming is also seen as repetitive.
  • There should be no [ or ] in the namespaces. Those were included in the sample patterns to show where you need to replace something with specifics for your service.
  • Mgmt Plane namespaces should be kept to only 3 levels.
    • For .NET this means only 3 words or phrases separated by .. So .NET would be Azure.ResourceManager.CodeSigning.

Please re-do the proposed namespaces to fit these rules.

@ashutak84
Copy link
Author

Thanks for the clarifications @ronniegeraghty i have updated the names, for .net our pms had decided to keep it as Azure.Developer.Signing

@ronniegeraghty
Copy link
Member

Thanks for the clarifications @ronniegeraghty i have updated the names, for .net our pms had decided to keep it as Azure.Developer.Signing

That will not work either. The mgmt plane namespaces need to follow the rules I listed above and the pattern for mgmt plane namespaces.
.NET namespaces must follow this pattern: Azure.ResourceManager.[ServiceName]. Replace [ServiceName] with the name of your service. So for this example I would suggest Azure.ResourceManager.DeveloperSigning. If you go with this proposal the other languages namespaces would have to switch from using CodeSigning as the service name, to using DeveloperSigning.

@ArthurMa1978
Copy link
Member

As offline synced with @ashutak84, we agreed to use developersigning :
.NET: Azure.ResourceManager.DeveloperSigning
Java: azure-resourcemanager-developersigning(com.azure.resourcemanager.developersigning)
Go/Golang: sdk/resourcemanager/developersigning/armdevelopersigning
JavaScript: @azure/arm-developersigning
Python: azure-mgmt-developersigning

@ashutak84 ashutak84 changed the title Board Review: Management Plane Namespace Review Azure.Developer.Signing Board Review: Management Plane Namespace Review Azure.DeveloperSigning Mar 12, 2024
@ashutak84 ashutak84 changed the title Board Review: Management Plane Namespace Review Azure.DeveloperSigning Board Review: Management Plane Namespace Review Azure.TrustedSigning Mar 12, 2024
@ashutak84
Copy link
Author

as per the last update from @ronniegeraghty's email i have updated it to trustedsigning please take a look at it and approve.

@ArthurMa1978 ArthurMa1978 added the mgmt-namespace-ready Approve the namespace review request of mgmt plan SDK label Mar 13, 2024
@ArthurMa1978
Copy link
Member

TrustedSigning is good for me.

@ronniegeraghty
Copy link
Member

Moving to phase 2 of the review process. The proposed namespaces will be shown to the Azure SDK Architecture Board and our architects will have 1 week to make any objections to the proposed namespaces. If there are no objections by 3/20 then the namespaces will be considered approved, and I'll close out this issue and leave a comment stating so.

@ronniegeraghty
Copy link
Member

The week is up and there have been no objections from our architects. The names in the description of this issue are considered approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
architecture board-review Request for an Architectural Board Review mgmt-namespace-ready Approve the namespace review request of mgmt plan SDK mgmt-namespace-review requests for namespace reviews of mgmt plane SDKs
Projects
None yet
Development

No branches or pull requests

4 participants