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

track2 modify iothub readme.go.md #15743

Merged
merged 2 commits into from
Sep 7, 2021

Conversation

Alancere
Copy link
Contributor

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @804873052 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 23, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 23, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-iothub - 2.0.0
    ️✔️azure-sdk-for-go - iothub/mgmt/2020-03-01/devices - v56.3.0
    ️✔️azure-sdk-for-go - iothub/mgmt/2018-04-01/devices - v56.3.0
    ️✔️azure-sdk-for-go - iothub/mgmt/2018-01-22/devices - v56.3.0
    ️✔️azure-sdk-for-go - iothub/mgmt/2017-07-01/devices - v56.3.0
    ️✔️azure-sdk-for-go - iothub/mgmt/2017-01-19/devices - v56.3.0
    ️✔️azure-sdk-for-go - iothub/mgmt/2016-02-03/devices - v56.3.0
    ️✔️azure-sdk-for-go - preview/iothub/mgmt/2021-03-03-preview/devices - v56.3.0
    ️✔️azure-sdk-for-go - preview/iothub/mgmt/2019-07-01-preview/devices - v56.3.0
    ️✔️azure-sdk-for-go - preview/iothub/mgmt/2019-03-22-preview/devices - v56.3.0
    ️✔️azure-sdk-for-go - preview/iothub/mgmt/2018-12-01-preview/devices - v56.3.0
    ️✔️azure-sdk-for-go-track2 - armiothub - 0.1.0
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from b052719. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      warn	No file changes detected after generation
      error	Fatal error: packageFolderFromFileSearch not configured and could not be found in legacy config
      packageFolderFromFileSearch not configured and could not be found in legacy config
      Error: packageFolderFromFileSearch not configured and could not be found in legacy config
          at workflowDetectChangedPackages (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:422:23)
          at workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:168:11)
          at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
          at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
          at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from b052719. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/iothub/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.IotHub [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from b052719. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-iothub [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from b052719. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-09-07 06:12:57 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-iothub;1.0.0;1.1.0"
      cmderr	[generate.py] 2021-09-07 06:12:57 WARNING [VERSION][Not Implement] set to current version "1.1.0" by default
      cmderr	[generate.py] 2021-09-07 06:12:57 INFO autorest --version=3.4.5 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/iothub/azure-resourcemanager-iothub --java.namespace=com.azure.resourcemanager.iothub   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/iothub/resource-manager/readme.md
      cmderr	[generate.py] 2021-09-07 06:13:32 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-iothub
      cmderr	[generate.py] 2021-09-07 06:13:32 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-09-07 06:13:32 INFO [POM][Skip] pom already has module azure-resourcemanager-iothub
      cmderr	[generate.py] 2021-09-07 06:13:32 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-09-07 06:13:32 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-09-07 06:13:32 INFO [POM][Skip] pom already has module sdk/iothub
      cmderr	[generate.py] 2021-09-07 06:13:32 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-iothub [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-09-07 06:15:36 DEBUG Got artifact_id: azure-resourcemanager-iothub
      cmderr	[Inst] 2021-09-07 06:15:36 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-09-07 06:15:36 DEBUG Got artifact: azure-resourcemanager-iothub-1.1.0.jar
      cmderr	[Inst] 2021-09-07 06:15:36 DEBUG Match jar package: azure-resourcemanager-iothub-1.1.0.jar
      cmderr	[Inst] 2021-09-07 06:15:36 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15743/azure-sdk-for-java/azure-resourcemanager-iothub/azure-resourcemanager-iothub-1.1.0.jar\" -o azure-resourcemanager-iothub-1.1.0.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-iothub -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-iothub-1.1.0.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from b052719. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️iothub/mgmt/2020-03-01/devices [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️iothub/mgmt/2018-04-01/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️iothub/mgmt/2018-01-22/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️iothub/mgmt/2017-07-01/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️iothub/mgmt/2017-01-19/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️iothub/mgmt/2016-02-03/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/iothub/mgmt/2021-03-03-preview/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/iothub/mgmt/2019-07-01-preview/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/iothub/mgmt/2019-03-22-preview/devices [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/iothub/mgmt/2018-12-01-preview/devices [View full logs
      info	[Changelog] No exported changes
    ️❌ azure-sdk-for-go-track2 failed [Detail]
    • Failed [Logs]Release - Generate from b052719. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
      cmderr	[generator automation-v2] [ERROR] total 1 error(s):
      cmderr	[generator automation-v2] [ERROR] cannot find any NewClientMethod in package
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from b052719. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/iothub/resource-manager/readme.md
    • ️✔️@azure/arm-iothub [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/iotHubClient.js → ./dist/arm-iothub.js...
      cmderr	[npmPack] created ./dist/arm-iothub.js in 447ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from b052719. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
    • ️✔️iothub [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    You also need to add azure-sdk-for-go-track2 in the swagger to sdk config section in readme.md to enable the track2 SDK automation for this RP

    @leni-msft leni-msft assigned jianyexi and unassigned leni-msft Sep 7, 2021
    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