Skip to content

Commit

Permalink
Start documentation on build (#15012)
Browse files Browse the repository at this point in the history
  • Loading branch information
chamons authored Jul 13, 2021
1 parent 4d71873 commit 4837ee4
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 28 deletions.
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,22 @@ 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.

Also please see these [guidelines][] about contributing to Azure projects.
## Building

SDKs are either old (track 1) or new (track 2):

- 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.

There currently is not a repository wide way to build or regenerate code.

## Guidelines and Code of Conduct

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.

Expand Down
28 changes: 1 addition & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +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).

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.
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

Expand All @@ -69,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/).

Expand Down Expand Up @@ -386,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
Expand Down
2 changes: 2 additions & 0 deletions azure-pipelines.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# This builds only track 1 SDKs. See eng\pipelines\templates\steps\build.yml for track 2.

trigger:
paths:
exclude:
Expand Down
2 changes: 2 additions & 0 deletions eng/pipelines/templates/steps/build.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# This builds only track 2 SDKs. See \azure-pipelines.yml for track 1.

parameters:
ServiceDirectory: ''
GoWorkspace: ''
Expand Down

0 comments on commit 4837ee4

Please sign in to comment.