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

[ContainerRegistry] README and CHANGELOG for beta.1 #14736

Merged
merged 3 commits into from
Apr 6, 2021
Merged

[ContainerRegistry] README and CHANGELOG for beta.1 #14736

merged 3 commits into from
Apr 6, 2021

Conversation

jeremymeng
Copy link
Member

  • Align with .NET README structure
  • Add one example to README
  • Improve CHANGELOG slightly

@jeremymeng jeremymeng added Client This issue points to a problem in the data-plane of the library. Container Registry labels Apr 5, 2021
@jeremymeng jeremymeng added this to the [2021] April milestone Apr 5, 2021
annelo-msft
annelo-msft reviewed Apr 6, 2021
View reviewed changes
sdk/containerregistry/container-registry/CHANGELOG.md
@@ -1,5 +1,8 @@
# Release History

## 1.0.0-beta.1 (Unreleased)
## 1.0.0-beta.1 (2021-04-06)
Copy link
Member

Choose a reason for hiding this comment

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

Do you need to add a line for beta.2 (Unreleased)?

Copy link
Member Author

Choose a reason for hiding this comment

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

The azsdk bot will open a PR after releasing this.

annelo-msft
annelo-msft reviewed Apr 6, 2021
View reviewed changes
sdk/containerregistry/container-registry/README.md

async function main() {
// Get the service endpoint from the environment
const endpoint = process.env.REGISTRY_ENDPOINT;
Copy link
Member

Choose a reason for hiding this comment

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

Would you mind adding a description below the sample to say that this is the login server plus the prefix http:// ? Is this fault tolerant if the user does/doesn't add a trailing / ?

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, it works with or without the trailing /

Copy link
Member Author

Choose a reason for hiding this comment

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

I will update my sample PR to mention the endpoint format #14750. Samples changes can be after releasing libraries.

annelo-msft
annelo-msft reviewed Apr 6, 2021
View reviewed changes
sdk/containerregistry/container-registry/README.md
}

console.log(" by pages");
const pages = client.listRepositories().byPage({ maxPageSize: 2 });
Copy link
Member

Choose a reason for hiding this comment

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

My understanding is that paging through a pageable by pages instead of single items is an advanced scenario. This is true at least for .NET. If it's true for TS as well, could the sample not iterate by pages?

Copy link
Member Author

Choose a reason for hiding this comment

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

We have both listing items, and listing by pages in almost all of our listing samples so I will keep it here.

Copy link
Member Author

Choose a reason for hiding this comment

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

okay this is readme. I will remove byPage()

annelo-msft
annelo-msft approved these changes Apr 6, 2021
View reviewed changes
Copy link
Member

@annelo-msft annelo-msft left a comment

Choose a reason for hiding this comment

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

Added a few comments.

@jeremymeng jeremymeng merged commit adf852c into Azure:master Apr 6, 2021
@jeremymeng jeremymeng deleted the acr-beta1-readme branch April 6, 2021 19:49
@jeremymeng jeremymeng mentioned this pull request Apr 6, 2021
Closed
jay-most pushed a commit to jay-most/azure-sdk-for-js that referenced this pull request Apr 26, 2021
@jeremymeng @vindicatesociety
[ContainerRegistry] README and CHANGELOG for beta.1 (Azure#14736)
bbe8fbe 
* [ContainerRegistry] README and CHANGELOG for beta.1

* README feedback

* Update release date in CHANGELOG
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jun 30, 2021
@shenshengkafei
CodeGen from PR 14736 in Azure/azure-rest-api-specs
ffcdc01 
Microsoft.Features: Add new API version 2021-07-01 (Azure#14736)

* The previous version in the 2021-08-1 folder

* Add new feature registration apis

* Update readme files

* Update readme file

* Remove feature configuration apis

* Fix avocado

* Fix validations

* Fix validation

* Fix validations

* Fix validation

* Fix title

* Fix validation

* Fix validation

* Fix readme

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* suppress r4009

* Fix validation

* Fix validation

* Fix python

* Fix readme

* Fix python

* Remove post api

* Update example api-versions

Co-authored-by: shenshengkafei <wudiadi1111@gmail.com>
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jun 30, 2021
@shenshengkafei
CodeGen from PR 14736 in Azure/azure-rest-api-specs
961c84a 
Microsoft.Features: Add new API version 2021-07-01 (Azure#14736)

* The previous version in the 2021-08-1 folder

* Add new feature registration apis

* Update readme files

* Update readme file

* Remove feature configuration apis

* Fix avocado

* Fix validations

* Fix validation

* Fix validations

* Fix validation

* Fix title

* Fix validation

* Fix validation

* Fix readme

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* suppress r4009

* Fix validation

* Fix validation

* Fix python

* Fix readme

* Fix python

* Remove post api

* Update example api-versions

Co-authored-by: shenshengkafei <wudiadi1111@gmail.com>
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jun 30, 2021
@shenshengkafei
CodeGen from PR 14736 in Azure/azure-rest-api-specs
6634efb 
Microsoft.Features: Add new API version 2021-07-01 (Azure#14736)

* The previous version in the 2021-08-1 folder

* Add new feature registration apis

* Update readme files

* Update readme file

* Remove feature configuration apis

* Fix avocado

* Fix validations

* Fix validation

* Fix validations

* Fix validation

* Fix title

* Fix validation

* Fix validation

* Fix readme

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* suppress r4009

* Fix validation

* Fix validation

* Fix python

* Fix readme

* Fix python

* Remove post api

* Update example api-versions

Co-authored-by: shenshengkafei <wudiadi1111@gmail.com>
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jun 30, 2021
@shenshengkafei
CodeGen from PR 14736 in Azure/azure-rest-api-specs
e459f83 
Microsoft.Features: Add new API version 2021-07-01 (Azure#14736)

* The previous version in the 2021-08-1 folder

* Add new feature registration apis

* Update readme files

* Update readme file

* Remove feature configuration apis

* Fix avocado

* Fix validations

* Fix validation

* Fix validations

* Fix validation

* Fix title

* Fix validation

* Fix validation

* Fix readme

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* suppress r4009

* Fix validation

* Fix validation

* Fix python

* Fix readme

* Fix python

* Remove post api

* Update example api-versions

Co-authored-by: shenshengkafei <wudiadi1111@gmail.com>
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jun 30, 2021
@shenshengkafei
CodeGen from PR 14736 in Azure/azure-rest-api-specs
66f713f 
Microsoft.Features: Add new API version 2021-07-01 (Azure#14736)

* The previous version in the 2021-08-1 folder

* Add new feature registration apis

* Update readme files

* Update readme file

* Remove feature configuration apis

* Fix avocado

* Fix validations

* Fix validation

* Fix validations

* Fix validation

* Fix title

* Fix validation

* Fix validation

* Fix readme

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* suppress r4009

* Fix validation

* Fix validation

* Fix python

* Fix readme

* Fix python

* Remove post api

* Update example api-versions

Co-authored-by: shenshengkafei <wudiadi1111@gmail.com>
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this pull request Jun 30, 2021
@shenshengkafei
CodeGen from PR 14736 in Azure/azure-rest-api-specs
0a9d0a8 
Microsoft.Features: Add new API version 2021-07-01 (Azure#14736)

* The previous version in the 2021-08-1 folder

* Add new feature registration apis

* Update readme files

* Update readme file

* Remove feature configuration apis

* Fix avocado

* Fix validations

* Fix validation

* Fix validations

* Fix validation

* Fix title

* Fix validation

* Fix validation

* Fix readme

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* Fix validation

* suppress r4009

* Fix validation

* Fix validation

* Fix python

* Fix readme

* Fix python

* Remove post api

* Update example api-versions

Co-authored-by: shenshengkafei <wudiadi1111@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@annelo-msft annelo-msft annelo-msft approved these changes

@seankane-msft seankane-msft seankane-msft approved these changes

@pallavit pallavit Awaiting requested review from pallavit

Assignees
No one assigned
Labels
Client This issue points to a problem in the data-plane of the library. Container Registry
Projects
None yet
Milestone
[2021] April
Development

Successfully merging this pull request may close these issues.
3 participants
@jeremymeng @annelo-msft @seankane-msft