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

Start documentation on build #15012

Merged
merged 4 commits into from
Jul 13, 2021
Merged

Start documentation on build #15012

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe62a96
Start documentation on build
chamons Jul 8, 2021
c4328ed
Update README.md
chamons Jul 8, 2021
fdd5f2f
Text review changes
chamons Jul 12, 2021
64edf6f
Fix link
chamons Jul 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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":
chamons marked this conversation as resolved.
Show resolved Hide resolved

- 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.
chamons marked this conversation as resolved.
Show resolved Hide resolved
chamons marked this conversation as resolved.
Show resolved Hide resolved
- CI is in \eng\pipelines\templates\steps\build.yml
chamons marked this conversation as resolved.
Show resolved Hide resolved

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.
chamons marked this conversation as resolved.
Show resolved Hide resolved

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
7 changes: 1 addition & 6 deletions README.md
View file
Open in desktop
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
chamons marked this conversation as resolved.
Show resolved Hide resolved
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 Down
2 changes: 2 additions & 0 deletions azure-pipelines.yml
View file
Open in desktop
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
View file
Open in desktop
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