Use fork repo for daily updates in Java #25677

sima-zhu · 2021-11-24T20:06:07Z

Description

The PR is to update the version to docs fork repo daily branch.
Keyvault testing:
From unified pipeline to fork repo:
https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1217760&view=logs&j=b1e79959-24d8-5aa9-2799-72d40c3e051b&t=77783793-89a5-5b26-f964-83f7ae88ef10
https://github.com/azure-sdk/azure-docs-sdk-java/blob/daily/2021-11-29/metadata/preview/azure-security-keyvault-administration.json#L4

From azure-sdk fork to main daily branch:
As we have unified pipeline and ci build run to override the changes. I have screenshot the changes in main repo.
https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1217885&view=results

Azure/azure-docs-sdk-java@a60c4e7

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

eng/pipelines/templates/stages/archetype-java-release.yml

weshaggard · 2021-11-29T21:43:21Z

eng/pipelines/docindex.yml

+      - pwsh: |
+          $dailyDocsRepoLocation = "$(DocRepoLocation)/dailyDocs"
+          echo "##vso[task.setvariable variable=DailyDocsRepoLocation]$dailyDocsRepoLocation"
+          if (!(Test-Path $dailyDocsRepoLocation)) {


Do we need to create this? Won't the clone create it?

The working directory contains two clones, 1 main branch from Azure repo, 2 daily branch from azure-sdk repo.
1 used in schedule run updating the Azure main repo. (For release ones)
2 used in schedule run updating the Azure daily repo. (For daily docs)

Both branches get updated in schedule run.

We can consider using the same clone but just adding a new remote that would save on some of the forking going on and the duplicate cloning.

weshaggard · 2021-11-29T21:43:48Z

eng/pipelines/docindex.yml

@@ -49,13 +49,30 @@ jobs:
      - template: /eng/common/pipelines/templates/steps/set-daily-docs-branch-name.yml
        parameters:
          DailyBranchVariableName: DailyDocsBranchName
+      # Sync docs fork repo onboarding files/folders
+      - pwsh: |
+          $dailyDocsRepoLocation = "$(DocRepoLocation)/dailyDocs"


Do we need to set this dynamically or can we set it statically where we define DocRepoLocation?

In DocRepoLocation ,

Pull remote Azure/main -> local Azure/main Push local Azure/main -> remote Azure/main

In dailyDocsRepoLocation ,

Pull remote azure-sdk/daily-> local azure-sdk/daily Push local azure-sdk/daily-> remote Azure/daily

These two steps both happen in schedule run

I think we can eliminate this pwsh task by setting the variable above:

variables: DocRepoLocation: $(Pipeline.Workspace)/docs DailyDocRepoLocation: $(Pipeline.Workspace)/dailyDocsFork # Add this line DocRepoOwner: Azure DocRepoName: azure-docs-sdk-java

That would eliminate the need to create this variable at runtime and the sparse checkout process handles creating the directory.

Yes that is wat I was wondering about. However see my other comment as well as we should consider just adding a remote to the fork instead of a separate clone.

eng/pipelines/docindex.yml

danieljurek · 2021-11-29T23:14:54Z

These changes and the runs look correct. I think we can eliminate some redundant complexity and this should be good to go 👍

sima-zhu · 2021-11-30T01:02:36Z

File another tests:
unified -> azure-sdk/daily
https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1217760&view=logs&j=b1e79959-24d8-5aa9-2799-72d40c3e051b&t=77783793-89a5-5b26-f964-83f7ae88ef10
https://github.com/azure-sdk/azure-docs-sdk-java/blob/daily/2021-11-30/metadata/preview/azure-security-keyvault-administration.json

azure-sdk/daily -> Azure/daily
https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1218528&view=logs&j=dc056dfc-c0cf-5958-c8c4-8da4f91a3739&t=a6454728-bccf-57f0-079a-ebcde92e8213

danieljurek

Approved.

This shouldn't hold up the merge but we can also remove TargetDocRepoName from the release template.

eng/pipelines/docindex.yml

sima-zhu · 2021-12-01T19:54:14Z

Hard-coded the daily branch
https://dev.azure.com/azure-sdk/internal/_build/results?buildId=1223424&view=logs&j=dc056dfc-c0cf-5958-c8c4-8da4f91a3739&t=d08ed1f2-0ec2-5498-48a9-682643d126ca

eng/pipelines/docindex.yml

Add 2023-09-01-preview for appplatform (Azure#25501) * Adds base for updating Microsoft.AppPlatform from version preview/2023-07-01-preview to version 2023-09-01-preview * Updates readme * Updates API version in new specs and examples * feat: fragment support swagger change (Azure#25314) * Add apiTryOutEnabledState properties for api portal for 2023-09-01-preview api (Azure#25322) * support war file deployment (Azure#25312) Co-authored-by: Yi Li <yili7@microsoft.com> * Fix exmaple for api portal api try-out feature (Azure#25337) * Add property `autoSync` in `KeyVaultCertificateProperties` (Azure#25331) * Add gateway apm reference (Azure#25408) * Add expand parameter for list deployment (Azure#25411) * Add expand parameter for list deployments API (Azure#25471) * change order of expand (Azure#25587) * Update readme.go.md (Azure#25634) * Update readme.go.md * Update readme.python.md * Update readme.ruby.md * Revert api portal try out feature (Azure#25677) Fix exmaple for api portal api try-out feature (Azure#25337)" * add API to list all server versions (Azure#25720) * add API to list all server versions * refine list supported server version API * refine description --------- Co-authored-by: Yi Li <yili7@microsoft.com> * use enum for autoSync (Azure#25722) * Update appplatform.json (Azure#25724) * certificate - rename enum (Azure#25723) * use enum for autoSync * rename enum * rename enum --------- Co-authored-by: guitarsheng <85543793+guitarsheng@users.noreply.github.com> Co-authored-by: Mason Chen <jiec@microsoft.com> Co-authored-by: Yi Li <109205537+yilims@users.noreply.github.com> Co-authored-by: Yi Li <yili7@microsoft.com> Co-authored-by: Jeff <1830237+domainname@users.noreply.github.com> Co-authored-by: ninpan-ms <71061174+ninpan-ms@users.noreply.github.com>

sima-zhu requested review from hallipr and weshaggard as code owners November 24, 2021 20:06

sima-zhu added 2 commits November 24, 2021 13:23

use fork

ca95682

checkin from fork repo to original repo

0c81929

sima-zhu force-pushed the fork_branch branch from 462e84e to 0c81929 Compare November 24, 2021 21:23

sima-zhu added 5 commits November 24, 2021 13:38

fix doxindex

e045403

remove exist

b951311

another way

88e4aa6

morefix

1f0ad01

create new folder

8ac0514

sima-zhu requested a review from danieljurek November 29, 2021 18:48

Update docindex.yml

eee1649

weshaggard reviewed Nov 29, 2021

View reviewed changes

eng/pipelines/templates/stages/archetype-java-release.yml Show resolved Hide resolved

weshaggard reviewed Nov 29, 2021

View reviewed changes

eng/pipelines/docindex.yml Outdated Show resolved Hide resolved

sima-zhu requested a review from weshaggard November 29, 2021 22:01

sima-zhu added 3 commits November 29, 2021 15:58

Added variables

d770563

Added variables

d64e8a4

Remove doc repo owner

087e8c4

danieljurek approved these changes Nov 30, 2021

View reviewed changes

weshaggard reviewed Nov 30, 2021

View reviewed changes

eng/pipelines/docindex.yml Outdated Show resolved Hide resolved

sima-zhu requested a review from weshaggard December 1, 2021 18:22

sima-zhu added 2 commits December 1, 2021 11:09

create remote to azure-sdk instead of clone

20eb245

Fix errors

7871736

weshaggard reviewed Dec 1, 2021

View reviewed changes

eng/pipelines/docindex.yml Show resolved Hide resolved

tweak more comands

8468d1d

sima-zhu requested a review from weshaggard December 1, 2021 21:47

weshaggard approved these changes Dec 2, 2021

View reviewed changes

sima-zhu merged commit bee5b9b into Azure:main Dec 2, 2021

sima-zhu deleted the fork_branch branch December 2, 2021 18:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use fork repo for daily updates in Java #25677

Use fork repo for daily updates in Java #25677

sima-zhu commented Nov 24, 2021 •

edited

Loading

weshaggard Nov 29, 2021

sima-zhu Nov 29, 2021

weshaggard Nov 29, 2021

weshaggard Nov 29, 2021

sima-zhu Nov 29, 2021 •

edited

Loading

sima-zhu Nov 29, 2021

danieljurek Nov 29, 2021

weshaggard Nov 29, 2021

danieljurek commented Nov 29, 2021

sima-zhu commented Nov 30, 2021 •

edited

Loading

danieljurek left a comment

sima-zhu commented Dec 1, 2021 •

edited

Loading

Use fork repo for daily updates in Java #25677

Use fork repo for daily updates in Java #25677

Conversation

sima-zhu commented Nov 24, 2021 • edited Loading

Description

All SDK Contribution checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sima-zhu Nov 29, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danieljurek commented Nov 29, 2021

sima-zhu commented Nov 30, 2021 • edited Loading

danieljurek left a comment

Choose a reason for hiding this comment

sima-zhu commented Dec 1, 2021 • edited Loading

sima-zhu commented Nov 24, 2021 •

edited

Loading

sima-zhu Nov 29, 2021 •

edited

Loading

sima-zhu commented Nov 30, 2021 •

edited

Loading

sima-zhu commented Dec 1, 2021 •

edited

Loading