From fe62a960d9cc43e34ff5fdb24e580ad35c6a5ff1 Mon Sep 17 00:00:00 2001 From: Chris Hamons Date: Thu, 8 Jul 2021 11:53:27 -0500 Subject: [PATCH 1/4] Start documentation on build --- CONTRIBUTING.md | 15 +++++++++++++++ README.md | 3 --- azure-pipelines.yml | 2 ++ eng/pipelines/templates/steps/build.yml | 2 ++ 4 files changed, 19 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d46cfb92e98..817fa85f693c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,21 @@ using [Azure/autorest.go][] and [Azure/autorest][]. These generated packages dep For bugs or feature requests you can submit them using the [Github issues page][issues] and filling the appropriate template. +## Building + +SDKs are either "track 1" or "track 2": + +- Track 1 SDKs are found in the services/ and profiles/ top level folders. + - CI is in \azure-pipelines.yml +- Track 2 SDK are foudn in the sdk/ top level folder. + - CI is in \eng\pipelines\templates\steps\build.yml + +To build, run `go build` from the respective SDK directory. + +There currently is not a repository wide way to build or regenerate code. + +## Guidelines and Code of Conduct + Also please see these [guidelines][] about contributing to Azure projects. This project follows the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][cocfaq]. Contact [opencode@microsoft.com][cocmail] with questions and comments. diff --git a/README.md b/README.md index 68496e73222c..73897c69e4f0 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,6 @@ APIs are updated frequently, we release a **new major version at the end of each month** with a full changelog. For more details and background see [SDK Update Practices](https://github.com/Azure/azure-sdk-for-go/wiki/SDK-Update-Practices). -To more reliably manage dependencies like the Azure SDK in your applications we -recommend [golang/dep](https://github.com/golang/dep). - Packages that are still in public preview can be found under the ./services/preview directory. Please be aware that since these packages are in preview they are subject to change, including breaking changes outside of a major semver bump. diff --git a/azure-pipelines.yml b/azure-pipelines.yml index d3304cb8e853..999af2b3f428 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,3 +1,5 @@ +# This builds only track 1 SDKs. See eng\pipelines\templates\steps\build.yml for track 2. + trigger: paths: exclude: diff --git a/eng/pipelines/templates/steps/build.yml b/eng/pipelines/templates/steps/build.yml index 0fb9a47fc73c..160790a34c6d 100644 --- a/eng/pipelines/templates/steps/build.yml +++ b/eng/pipelines/templates/steps/build.yml @@ -1,3 +1,5 @@ +# This builds only track 2 SDKs. See \azure-pipelines.yml for track 1. + parameters: ServiceDirectory: '' GoWorkspace: '' From c4328ed120e2ad365af72a018cc4be51fb287952 Mon Sep 17 00:00:00 2001 From: Chris Hamons Date: Thu, 8 Jul 2021 12:40:06 -0500 Subject: [PATCH 2/4] Update README.md Co-authored-by: Sean Kane <68240067+seankane-msft@users.noreply.github.com> --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 73897c69e4f0..e060101c61fd 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,7 @@ APIs are updated frequently, we release a **new major version at the end of each month** with a full changelog. For more details and background see [SDK Update Practices](https://github.com/Azure/azure-sdk-for-go/wiki/SDK-Update-Practices). -Packages that are still in public preview can be found under the ./services/preview -directory. Please be aware that since these packages are in preview they are subject -to change, including breaking changes outside of a major semver bump. +Packages that are still in public preview can be found under the `services/preview` directory. Please be aware that since these packages are in preview they are subject to change, including breaking changes, outside of a major semver bump. ## Other Azure Go Packages From fdd5f2fcfb3a1c927cb4627cb94f4600b9bc52fd Mon Sep 17 00:00:00 2001 From: Chris Hamons Date: Mon, 12 Jul 2021 10:28:14 -0500 Subject: [PATCH 3/4] Text review changes --- CONTRIBUTING.md | 10 +++++----- README.md | 21 --------------------- 2 files changed, 5 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 817fa85f693c..acfe5271fcad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,12 +12,12 @@ For bugs or feature requests you can submit them using the [Github issues page][ ## Building -SDKs are either "track 1" or "track 2": +SDKs are either old (track 1) or new (track 2): -- Track 1 SDKs are found in the services/ and profiles/ top level folders. - - CI is in \azure-pipelines.yml -- Track 2 SDK are foudn in the sdk/ top level folder. - - CI is in \eng\pipelines\templates\steps\build.yml +- Old (Track 1) SDKs are found in the services/ and profiles/ top level folders. + - CI is in /azure-pipelines.yml +- New (Track 2) SDKs are found in the sdk/ top level folder. + - CI is in /eng/pipelines/templates/steps/build.yml To build, run `go build` from the respective SDK directory. diff --git a/README.md b/README.md index e060101c61fd..74ba62eeffd8 100644 --- a/README.md +++ b/README.md @@ -64,11 +64,6 @@ $ go get -u github.com/Azure/azure-sdk-for-go/... and you should also make sure to include the minimum version of [`go-autorest`](https://github.com/Azure/go-autorest) that is specified in `Gopkg.toml` file. -Or if you use dep, within your repo run: - -```sh -$ dep ensure -add github.com/Azure/azure-sdk-for-go -``` If you need to install Go, follow [the official instructions](https://golang.org/dl/). @@ -381,22 +376,6 @@ or `Profile` version (`2017-03-09`): import "github.com/Azure/azure-sdk-for-go/profiles/2017-03-09/compute/mgmt/compute" ``` -As well as, for dep, a `Gopkg.toml` file with: - -```toml -[[constraint]] - name = "github.com/Azure/azure-sdk-for-go" - version = "21.0.0" -``` - -Combined, these techniques will ensure that breaking changes should not occur. If you are extra sensitive to changes, adding an additional [version pin](https://golang.github.io/dep/docs/Gopkg.toml.html#version-rules) in your SDK Version should satisfy your needs: - -```toml -[[constraint]] - name = "github.com/Azure/azure-sdk-for-go" - version = "=21.3.0" -``` - ## Inspecting and Debugging ### Built-in Basic Request/Response Logging From 64edf6f4acf243268a2ac2433a02a68bb8038d74 Mon Sep 17 00:00:00 2001 From: Chris Hamons Date: Mon, 12 Jul 2021 10:32:59 -0500 Subject: [PATCH 4/4] Fix link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index acfe5271fcad..1af84420feb4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ There currently is not a repository wide way to build or regenerate code. ## Guidelines and Code of Conduct -Also please see these [guidelines][] about contributing to Azure projects. +Also please see these [guidelines][guidelines] about contributing to Azure projects. This project follows the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][cocfaq]. Contact [opencode@microsoft.com][cocmail] with questions and comments.