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

Fix Java Links in the root README #6925

Merged
merged 4 commits into from
Dec 19, 2019
Merged

Fix Java Links in the root README #6925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b002fb
Fix Java Links in the root README
JimSuplizio Dec 17, 2019
4229fc8
Update core readme.md link
JimSuplizio Dec 17, 2019
21175bf
run rel link replace before creating doc index
JimSuplizio Dec 18, 2019
0fb1f1a
Update for python args quotes problem
JimSuplizio Dec 19, 2019
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Each service might have a number of libraries available from each of the followi

### Client: GA December 2019 Releases

New wave of packages that were released in December 2019 client library as General Availability (GA) and several others that were released in **beta**. These libraries follow the [Azure SDK Design Guidelines for Java](https://azure.github.io/azure-sdk/java/guidelines/) 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 [here](sdk/core/README.md).
New wave of packages that were released in December 2019 client library as General Availability (GA) and several others that were released in **beta**. These libraries follow the [Azure SDK Design Guidelines for Java](https://azure.github.io/azure-sdk/java/guidelines/) 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 [here](https://github.com/Azure/azure-sdk-for-java/blob/azure-core_1.1.0/sdk/core/azure-core/README.md).

These libraries can be easily identified by sdk/ folder, package, and namespaces names starting with `azure-`, e.g. `azure-keyvault`.

Expand Down
12 changes: 12 additions & 0 deletions eng/pipelines/docindex.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ jobs:
pool:
vmImage: windows-2019
steps:
- task: UsePythonVersion@0
Copy link
Member

Choose a reason for hiding this comment

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

@scbedd orthogonal to Jim's change here but is it worth adding the UsePythonVersion in the template instead of needing to call it explicitly? Or do most pipelines already explicitly setup a python version?

Copy link
Member

Choose a reason for hiding this comment

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

The script is designed to be usable on any of the major python versions we leverage. Originally I was hesitant to add to the script itself because we need to restore the path back to what it was prior to running this script.

@JimSuplizio did this fail if you didn't UsePythonVersion?

Copy link
Member

Choose a reason for hiding this comment

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

Because if that's the case that is unexpected to me and I'd like to resolve that.

Copy link
Member

Choose a reason for hiding this comment

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

While not exactly the same I tried running the versioning update scripts without setting this and it failed. https://dev.azure.com/azure-sdk/internal/_build/results?buildId=216201&view=logs&j=a8b3ef96-4a4b-559b-f023-10f869b6ec93&t=b95ceac7-6b57-5697-85af-4d84d95bb884. I suspect it is because it ran on an earlier version of Python. I will verify that buy explicitly setting the python version.

displayName: 'Use Python 3.6'
inputs:
versionSpec: '3.6'

- template: eng/pipelines/templates/scripts/replace-relative-links.yml@azure-sdk-tools
parameters:
TargetFolder: .
Copy link
Member

Choose a reason for hiding this comment

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

Does this support passing in a single file?

Copy link
Member Author

Choose a reason for hiding this comment

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

Unfortunately, no, the script takes directory arguments.

RootFolder: .
BuildSHA: $(Build.SourceVersion)
RepoId: 'Azure/azure-sdk-for-java'

- pwsh: |
Invoke-WebRequest -Uri "https://github.com/dotnet/docfx/releases/download/v2.43.2/docfx.zip" `
-OutFile "docfx.zip" | Wait-Process; Expand-Archive -Path "docfx.zip" -DestinationPath "./docfx/"
Expand Down