Skip to content

Commit 0667e82

Browse files
authored
Artifact Powered Docs.MS Release (Azure#11395)
* abstracting staging of filtered artifacts * adding docs.ms release steps
1 parent ef37aa6 commit 0667e82

File tree

6 files changed

+90
-27
lines changed

6 files changed

+90
-27
lines changed

eng/common/pipelines/templates/steps/docs-metadata-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ steps:
5555
PRTitle: "Docs.MS Readme Update."
5656
BaseBranchName: smoke-test
5757
WorkingDirectory: ${{parameters.WorkingDirectory}}/repo
58-
ScriptDirectory: ${{parameters.WorkingDirectory}}/${{parameters.ScriptDirectory}}
58+
ScriptDirectory: ${{parameters.WorkingDirectory}}/${{parameters.ScriptDirectory}}

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

Lines changed: 62 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ parameters:
44
DependsOn: Build
55
DocArtifact: 'documentation'
66
DevFeedName: public/azure-sdk-for-python
7+
TargetDocRepoOwner: ''
8+
TargetDocRepoName: ''
79

810
stages:
911
- ${{if and(eq(variables['Build.Reason'], 'Manual'), eq(variables['System.TeamProject'], 'internal'))}}:
@@ -26,15 +28,15 @@ stages:
2628
deploy:
2729
steps:
2830
- checkout: self
31+
- template: /eng/pipelines/templates/steps/stage-filtered-artifacts.yml
32+
parameters:
33+
SourceFolder: ${{parameters.ArtifactName}}
34+
TargetFolder: ${{artifact.safeName}}
35+
PackageName: ${{artifact.name}}
2936
- pwsh: |
30-
Get-ChildItem $(Pipeline.Workspace)/${{parameters.ArtifactName}}
31-
New-Item -Type Directory -Name ${{artifact.safeName}} -Path $(Pipeline.Workspace)
32-
$underscorePrefix = "${{artifact.name}}"
33-
$dashPrefix = "${{artifact.name}}".Replace("_", "-")
34-
Copy-Item $(Pipeline.Workspace)/${{parameters.ArtifactName}}/$dashPrefix-[0-9]*.[0-9]*.[0-9]* $(Pipeline.Workspace)/${{artifact.safeName}}
35-
Copy-Item $(Pipeline.Workspace)/${{parameters.ArtifactName}}/$underscorePrefix-[0-9]*.[0-9]*.[0-9]* $(Pipeline.Workspace)/${{artifact.safeName}}
36-
Get-ChildItem $(Pipeline.Workspace)/${{artifact.safeName}}
37-
displayName: Stage artifacts
37+
Get-ChildItem -Recurse $(Pipeline.Workspace)/${{artifact.safeName}}
38+
workingDirectory: $(Pipeline.Workspace)
39+
displayName: Output Visible Artifacts
3840
- template: /eng/common/pipelines/templates/steps/create-tags-and-git-release.yml
3941
parameters:
4042
ArtifactLocation: $(Pipeline.Workspace)/${{artifact.safeName}}
@@ -62,14 +64,11 @@ stages:
6264
artifact: ${{parameters.ArtifactName}}
6365
timeoutInMinutes: 5
6466

65-
- pwsh: |
66-
Get-ChildItem $(Pipeline.Workspace)/${{parameters.ArtifactName}}
67-
New-Item -Type Directory -Name ${{artifact.safeName}} -Path $(Pipeline.Workspace)
68-
$underscorePrefix = "${{artifact.name}}"
69-
$dashPrefix = "${{artifact.name}}".Replace("_", "-")
70-
Copy-Item $(Pipeline.Workspace)/${{parameters.ArtifactName}}/$dashPrefix-[0-9]*.[0-9]*.[0-9]* $(Pipeline.Workspace)/${{artifact.safeName}}
71-
Copy-Item $(Pipeline.Workspace)/${{parameters.ArtifactName}}/$underscorePrefix-[0-9]*.[0-9]*.[0-9]* $(Pipeline.Workspace)/${{artifact.safeName}}
72-
Get-ChildItem $(Pipeline.Workspace)/${{artifact.safeName}}
67+
- template: /eng/pipelines/templates/steps/stage-filtered-artifacts.yml
68+
parameters:
69+
SourceFolder: ${{parameters.ArtifactName}}
70+
TargetFolder: ${{artifact.safeName}}
71+
PackageName: ${{artifact.name}}
7372

7473
- task: UsePythonVersion@0
7574

@@ -105,7 +104,7 @@ stages:
105104
displayName: 'Publish package to feed: ${{parameters.DevFeedName}}'
106105
107106
- ${{if ne(artifact.options.skipPublishDocs, 'true')}}:
108-
- deployment: PublishDocs
107+
- deployment: PublishGitHubIODocs
109108
displayName: Publish Docs to GitHubIO Blob Storage
110109
condition: and(succeeded(), ne(variables['Skip.PublishDocs'], 'true'))
111110
environment: githubio
@@ -119,12 +118,12 @@ stages:
119118
deploy:
120119
steps:
121120
- checkout: self
122-
- pwsh: |
123-
Get-ChildItem $(Pipeline.Workspace)/${{parameters.DocArtifact}}
124-
New-Item -Type Directory -Name ${{artifact.safeName}} -Path $(Pipeline.Workspace)
125-
$dashPrefix = "${{artifact.name}}".Replace("_", "-")
126-
Copy-Item $(Pipeline.Workspace)/${{parameters.DocArtifact}}/$dashPrefix.zip $(Pipeline.Workspace)/${{artifact.safeName}}
127-
displayName: Stage artifacts
121+
- template: /eng/pipelines/templates/steps/stage-filtered-artifacts.yml
122+
parameters:
123+
SourceFolder: ${{parameters.DocArtifact}}
124+
TargetFolder: ${{artifact.safeName}}
125+
PackageName: ${{artifact.name}}
126+
AdditionalRegex: '.zip'
128127
- pwsh: |
129128
Get-ChildItem -Recurse $(Pipeline.Workspace)/${{artifact.safeName}}
130129
workingDirectory: $(Pipeline.Workspace)
@@ -138,6 +137,46 @@ stages:
138137
# we override the regular script path because we have cloned the build tools repo as a separate artifact.
139138
ScriptPath: 'eng/common/scripts/copy-docs-to-blobstorage.ps1'
140139

140+
- ${{if ne(artifact.options.skipPublishDocs, 'true')}}:
141+
- deployment: PublishDocs
142+
displayName: "Docs.MS Release"
143+
condition: and(succeeded(), ne(variables['Skip.PublishDocs'], 'true'))
144+
environment: githubio
145+
dependsOn: PublishPackage
146+
147+
pool:
148+
vmImage: ubuntu-18.04
149+
150+
strategy:
151+
runOnce:
152+
deploy:
153+
steps:
154+
- checkout: self
155+
- template: /eng/pipelines/templates/steps/stage-filtered-artifacts.yml
156+
parameters:
157+
SourceFolder: ${{parameters.ArtifactName}}
158+
TargetFolder: ${{artifact.safeName}}
159+
PackageName: ${{artifact.name}}
160+
- pwsh: |
161+
Get-ChildItem -Recurse $(Pipeline.Workspace)/${{artifact.safeName}}
162+
workingDirectory: $(Pipeline.Workspace)
163+
displayName: Output Visible Artifacts
164+
- template: /eng/common/pipelines/templates/steps/docs-metadata-release.yml
165+
parameters:
166+
ArtifactLocation: $(Pipeline.Workspace)/${{artifact.safeName}}
167+
PackageRepository: PyPI
168+
ReleaseSha: $(Build.SourceVersion)
169+
RepoId: Azure/azure-sdk-for-python
170+
WorkingDirectory: $(System.DefaultWorkingDirectory)
171+
TargetDocRepo: 'MicrosoftDocs/azure-docs-sdk-python'
172+
TargetDocRepoOwner: ${{parameters.TargetDocRepoOwner}}
173+
TargetDocRepoName: ${{parameters.TargetDocRepoName}}
174+
PRBranchName: 'smoke-test-rdme'
175+
ArtifactName: ${{parameters.ArtifactName}}
176+
Language: 'python'
177+
ServiceDirectory: ${{ parameters.ServiceDirectory }}
178+
DocRepoDestinationPath: 'docs-ref-services/'
179+
141180
- ${{if ne(artifact.options.skipUpdatePackageVersion, 'true')}}:
142181
- deployment: UpdatePackageVersion
143182
displayName: "Update Package Version"

eng/pipelines/templates/stages/archetype-sdk-client.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ parameters:
44
ToxEnvParallel: '--tenvparallel'
55
InjectedPackages: ''
66
BuildDocs: true
7-
7+
TargetDocRepoOwner: 'MicrosoftDocs'
8+
TargetDocRepoName: 'azure-docs-sdk-python'
89

910
stages:
1011
- stage: Build
@@ -24,4 +25,6 @@ stages:
2425
ServiceDirectory: ${{parameters.ServiceDirectory}}
2526
Artifacts: ${{parameters.Artifacts}}
2627
ArtifactName: packages
27-
DocArtifact: documentation
28+
DocArtifact: documentation
29+
TargetDocRepoOwner: ${{parameters.TargetDocRepoOwner}}
30+
TargetDocRepoName: ${{parameters.TargetDocRepoName}}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
parameters:
2+
SourceFolder: '' # ArtifactName (aka "packages")
3+
TargetFolder: '' # artifact.safename (azuretemplate)
4+
PackageName: '' # artifact.name (azure-template)
5+
AdditionalRegex: '-[0-9]*.[0-9]*.[0-9]*'
6+
7+
steps:
8+
- pwsh: |
9+
New-Item -Type Directory -Name ${{parameters.TargetFolder}} -Path $(Pipeline.Workspace)
10+
$underscorePrefix = "${{parameters.PackageName}}"
11+
$dashPrefix = "${{parameters.PackageName}}".Replace("_", "-")
12+
Copy-Item $(Pipeline.Workspace)/${{parameters.SourceFolder}}/$dashPrefix${{parameters.AdditionalRegex}} $(Pipeline.Workspace)/${{parameters.TargetFolder}}
13+
Copy-Item $(Pipeline.Workspace)/${{parameters.SourceFolder}}/$underscorePrefix${{parameters.AdditionalRegex}} $(Pipeline.Workspace)/${{parameters.TargetFolder}} -ErrorAction SilentlyContinue
14+
displayName: Stage artifacts

sdk/template/azure-template/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
# Release History
2+
3+
## 0.0.6 (2020-05-20)
4+
- Test a successful Release
5+
6+
## 0.0.5 (2020-05-20)
7+
- Test a successful Release
8+
29
## 0.0.3 (Unreleased)
310

411
## 0.0.2 (2020-03-24)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# matches SEMVER
2-
VERSION = "0.0.3"
2+
VERSION = "0.0.6"

0 commit comments

Comments
 (0)