github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update the repo readmes and changelog (#627)

Browse Source 
* Update the repo readmes and changelog

* Lowercase beta

* Fix a couple instances of `preview`
This commit is contained in:
Rick Winter 2020-09-09 16:55:57 -07:00 committed by GitHub
parent db4f318ffa
commit 6b1043fc3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -2,37 +2,36 @@
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/cpp/cpp%20-%20client%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1611&branchName=master)
This repository is for active development of the Azure SDK for C++.
This repository is for active development of the Azure SDK for C++. For consumers of the SDK we recommend visiting our [public developer docs](https://azure.github.io/azure-sdk-for-cpp) or our versioned [developer docs](https://azure.github.io/azure-sdk-for-cpp).
## Getting started
To get started with a specific library, see the **README.md** file located in the library's project folder. You can find service libraries in the `/sdk` directory.
To get started with a library, see the **README.md** file located in the library's project folder. You can find these library folders grouped by service in the `/sdk` directory.
### Prerequisites
For tutorials, samples, quick starts, and other documentation, go to [Azure for C++ Developers](https://azure.github.io/azure-sdk-for-cpp).
> CMake version 3.15 is required to build these libraries
## Packages available
Each service might have a number of libraries available from each of the following categories:
* [Client - New Releases](#Client-New-Releases)
* [Client - Previous Versions](#Client-Previous-Versions)
## Latest Release
### Client: New Releases
> NOTE: All code in this repro is in development state and should not be used in production.
New wave of packages that we are announcing as **GA** and several that are currently releasing in **beta**. These libraries follow the [Azure SDK Design Guidelines for C++](https://azure.github.io/azure-sdk/cpp_introduction.html) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features at [Azure::Core](sdk/core/azure-core/README.md).
### Previous GA Releases
These new client libraries can be identified by the naming used for their folder, package, and namespace. Each will start with `azure`, followed by the service category, and then the name of the service. For example `azure-storage-blobs`.
- [TODO]`https://azure.github.io/azure-sdk/releases/Year-Month/cpp.html`
For a complete list of available packages, please see the [latest available packages](https://azure.github.io/azure-sdk/releases/latest/) page.
> NOTE: If you need to ensure your code is ready for production use one of the stable, non-preview libraries.
> NOTE: If you need to ensure your code is ready for production we strongly recommend using one of the stable, non-beta libraries.
### Client: Previous Versions
TODO
### Management
Libraries which enable you to provision specific resources. They are responsible for directly mirroring and consuming Azure service's REST endpoints. Management library directories contain `-mgmt-`, e.g. `azure-mgmt-keyvault`.
Last stable versions of packages that are production-ready. These libraries provide similar functionalities to the beta packages, as they allow you to use and consume existing resources and interact with them, for example: upload a storage blob. They might not implement the [guidelines](https://azure.github.io/azure-sdk/cpp_introduction.html) or have the same feature set. They do however offer wider coverage of services.
## Need help
- For reference documentation visit the `Azure SDK for C++ documentation`[todo].
- For reference documentation visit the [Azure SDK for C++ documentation](https://azure.github.io/azure-sdk-for-cpp).
- For tutorials, samples, quick starts and other documentation, visit [Azure for C++ Developers](https://docs.microsoft.com/azure/).
- For build reports on code quality, test coverage, etc, visit [Azure SDK for C++]<!--https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-cpp/index.html-->.
- File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-cpp/issues/new/choose).
@ -41,11 +40,11 @@ Libraries which enable you to provision specific resources. They are responsible
### Master branch
The master branch has the most recent code with new features and bug fixes. It does **not** represent latest released **GA** SDK.
The master branch has the most recent code with new features and bug fixes. It does **not** represent latest released **beta** or **GA** SDK.
### Release branches (Release tagging)
For each package we release there will be a unique git tag created that contains the name and the version of the package to mark the commit of the code that produced the package. This tag will be used for servicing via hotfix branches as well as debugging the code for a particular preview or stable release version.
For each package we release there will be a unique git tag created that contains the name and the version of the package to mark the commit of the code that produced the package. This tag will be used for servicing via hotfix branches as well as debugging the code for a particular beta or stable release version.
Format of the release tags are `<package-name>_<package-version>`. For more information please see [our branching strategy](https://github.com/Azure/azure-sdk/blob/master/docs/policies/repobranching.md#release-tagging).
## Contributing

5
sdk/core/azure-core/CHANGELOG.md
View File

@ -1,5 +1,6 @@
# Release History
## 1.0.0-preview.1 (Unreleased)
## 1.0.0-beta.1 (2020-09-09)
- Initial release
* Testing. Validating automation.

54
sdk/core/azure-core/README.md
View File

@ -1,52 +1,33 @@
# Azure SDK Core Library for C++
Azure Core library for C++ (`azure-core`) provides shared primitives, abstractions, and helpers for modern Azure SDK client libraries written in the C++ programming language. These libraries follow the Azure SDK Design Guidelines for C++.
Azure::Core (`azure-core`) provides shared primitives, abstractions, and helpers for modern Azure SDK client libraries written in the C++. These libraries follow the [Azure SDK Design Guidelines for C++][azure_sdk_cpp_development_guidelines].
The library allows client libraries to expose common functionality in a consistent fashion. Once you learn how to use these APIs in one client library, you will know how to use them in other client libraries.
## Getting started
TODO
Typically, you will not need to download `azure-core`; it will be downloaded for you as a dependency of the client libraries. In case you want to download it explicitly (to implement your own client library, for example), you can find the source
in here.
## Key concepts
TODO
### Error Structure
TODO
### Span of bytes
TODO
### Strings
TODO
## Examples
TODO
The main shared concepts of Azure::Core include:
- Configuring service cliesnt, e.g. configuring retries, logging, etc.. (`ClientOptions`)
- Accessing HTTP response details (`Response`, `Response<T>`)
- Polling long-running operations
- Exceptions for reporting errors from service requests in a consistent fashion (`RequestFailedException`)
- Abstractions for Azure SDK Credentials (`TokenCredential`)
## Troubleshooting
### General
TODO
### Retry policy
While working with Azure you might encounter transient failures. For information about handling these types of failures, see [Retry pattern][azure_pattern_retry] in the Cloud Design Patterns guide, and the related [Circuit Breaker pattern][azure_pattern_circuit_breaker].
Three main ways of troubleshooting failures are:
- Inspecting exceptions
- Enabling logging (`Available in future release`)
- Distributed tracing (`Available in future release`)
## Next steps
### More sample code
TODO
### Additional documentation
TODO
Explore and install available Azure SDK libraries.
## Contributing
For details on contributing to this repository, see the [contributing guide][azure_sdk_for_cpp_contributing].
@ -81,9 +62,10 @@ Security issues and bugs should be reported privately, via email, to the Microso
Azure SDK for C++ is licensed under the [MIT](LICENSE) license.
<!-- LINKS -->
[azure_sdk_for_c_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md
[azure_sdk_for_c_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#developer-guide
[azure_sdk_for_c_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests
[azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md
[azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#developer-guide
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests
[azure_sdk_cpp_development_guidelines]: https://azure.github.io/azure-sdk/cpp_introduction.html
[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_pattern_circuit_breaker]: https://docs.microsoft.com/azure/architecture/patterns/circuit-breaker
[azure_pattern_retry]: https://docs.microsoft.com/azure/architecture/patterns/retry