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

Documentation shows wrong module version in go get commands #22127

Closed
divega opened this issue Dec 11, 2023 · 4 comments
Closed

Documentation shows wrong module version in go get commands #22127

divega opened this issue Dec 11, 2023 · 4 comments
Assignees
@raych1
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs Mgmt This issue is related to a management-plane library. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team

Comments

@divega
Copy link

divega commented Dec 11, 2023

For example, the documentation for v4 of the network module shows the command to get the v2 version of the module:

azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/README.md

Line 23 in b1a2f3d

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v2

I haven't checked but I wouldn't be surprised if other versions are incorrect.

The bug in the documentation is reflected in https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v4#section-readme as well.
@github-actions github-actions bot added customer-reported Issues that are reported by GitHub users external to the Azure organization. needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Dec 11, 2023
@jhendrixMSFT jhendrixMSFT added Docs Mgmt This issue is related to a management-plane library. and removed question The issue doesn't require a change to the product in order to be resolved. Most issues start as that needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Dec 11, 2023
@github-actions github-actions bot added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Dec 11, 2023
@lirenhe
Copy link
Member

lirenhe commented Dec 12, 2023

@raych1, could you help to take a look?

@raych1
Copy link
Member

raych1 commented Dec 12, 2023

@divega , thanks for reporting this issue. readme.md will be updated in this month's release.

@raych1 raych1 removed the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Dec 12, 2023
@github-actions github-actions bot added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Dec 12, 2023
@Alancere Alancere mentioned this issue Dec 13, 2023
Closed
@raych1
Copy link
Member

raych1 commented Dec 18, 2023

The module version has been corrected at https://github.com/Azure/azure-sdk-for-go/blob/main/sdk/resourcemanager/network/armnetwork/README.md.

And the next release in this month will have the new right version.

@tadelesh
Copy link
Member

New version released.

@github-actions github-actions bot locked and limited conversation to collaborators Mar 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@raych1 raych1

Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs Mgmt This issue is related to a management-plane library. needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@divega @tadelesh @lirenhe @jhendrixMSFT @raych1