Exercício – Publicar o resultado no pipeline

  • 10 minutos

Neste ponto, você pode criar o projeto Web Space Game por meio do pipeline.

Mas para que local vão os resultados do build? Agora, a saída do build permanece no servidor de build temporário. Clara precisa encontrar uma forma de entregar este build a Marina para que ela possa começar o teste.

Você pode armazenar os artefatos de compilação no Azure Pipelines, de modo que eles estejam disponíveis mais tarde para outras pessoas em sua equipe após a conclusão do build. Isso é o que você fará aqui. Como bônus, você também refatorará a configuração de build para usar variáveis, a fim de fazer com que a configuração seja mais fácil de ser lida e mantida atualizada.

Observação

O Azure Pipelines permite que você implante automaticamente o aplicativo compilado em um ambiente de teste ou de produção em execução na nuvem ou no datacenter. Por enquanto, a meta de Clara é apenas produzir builds que ela possa entregar à garantia de qualidade usando os processos existentes deles.

Publicar o build no pipeline

No .NET, você pode empacotar seu aplicativo como um arquivo .zip. Em seguida, você pode usar a tarefa PublishBuildArtifacts@1 interna para publicar o arquivo .zip no Azure Pipelines.

  1. No Visual Studio Code, altere o azure-pipelines.yml como você vê aqui:

    trigger:
- '*'

pool:
  name: 'Default' #replace if needed with name of your agent pool

steps:
- task: UseDotNet@2
  displayName: 'Use .NET SDK 6.x'
  inputs:
    version: '6.x'

- task: Npm@1
  displayName: 'Run npm install'
  inputs:
    verbose: false

- script: './node_modules/.bin/node-sass Tailspin.SpaceGame.Web/wwwroot --output Tailspin.SpaceGame.Web/wwwroot'
  displayName: 'Compile Sass assets'

- task: gulp@1
  displayName: 'Run gulp tasks'

- script: 'echo "$(Build.DefinitionName), $(Build.BuildId), $(Build.BuildNumber)" > buildinfo.txt'
  displayName: 'Write build info'
  workingDirectory: Tailspin.SpaceGame.Web/wwwroot

- task: DotNetCoreCLI@2
  displayName: 'Restore project dependencies'
  inputs:
    command: 'restore'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Build the project - Release'
  inputs:
    command: 'build'
    arguments: '--no-restore --configuration Release'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Publish the project - Release'
  inputs:
    command: 'publish'
    projects: '**/*.csproj'
    publishWebProjects: false
    arguments: '--no-build --configuration Release --output $(Build.ArtifactStagingDirectory)/Release'
    zipAfterPublish: true

- task: PublishBuildArtifacts@1
  displayName: 'Publish Artifact: drop'
  condition: succeeded()

    trigger:
- '*'

pool:
  vmImage: ubuntu-latest

steps:
- task: UseDotNet@2
  displayName: 'Use .NET SDK 6.x'
  inputs:
    version: '6.x'

- task: Npm@1
  displayName: 'Run npm install'
  inputs:
    verbose: false

- script: './node_modules/.bin/node-sass Tailspin.SpaceGame.Web/wwwroot --output Tailspin.SpaceGame.Web/wwwroot'
  displayName: 'Compile Sass assets'

- task: gulp@1
  displayName: 'Run gulp tasks'

- script: 'echo "$(Build.DefinitionName), $(Build.BuildId), $(Build.BuildNumber)" > buildinfo.txt'
  displayName: 'Write build info'
  workingDirectory: Tailspin.SpaceGame.Web/wwwroot

- task: DotNetCoreCLI@2
  displayName: 'Restore project dependencies'
  inputs:
    command: 'restore'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Build the project - Release'
  inputs:
    command: 'build'
    arguments: '--no-restore --configuration Release'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Publish the project - Release'
  inputs:
    command: 'publish'
    projects: '**/*.csproj'
    publishWebProjects: false
    arguments: '--no-build --configuration Release --output $(Build.ArtifactStagingDirectory)/Release'
    zipAfterPublish: true

- task: PublishBuildArtifacts@1
  displayName: 'Publish Artifact: drop'
  condition: succeeded()

    Esta versão de azure-pipelines.yml se parece com a versão anterior, mas também adiciona duas outras tarefas.

    A primeira delas usa a tarefa DotNetCoreCLI@2 para publicar ou empacotar os resultados de build do aplicativo (incluindo as dependências dele) em uma pasta. O argumento zipAfterPublish especifica a adição dos resultados compilados em um arquivo .zip.

    A segunda tarefa usa a tarefa PublishBuildArtifacts@1 para publicar o arquivo .zip no Azure Pipelines. O argumento condition especifica a execução da tarefa somente quando a tarefa anterior for bem-sucedida. succeeded() é a condição padrão, portanto, você não precisa especificá-la. No entanto, nós a mostraremos aqui para mostrar o uso dela.

  2. No terminal integrado, adicione azure-pipelines.yml ao índice, confirme a alteração e envie a alteração por push ao GitHub.

    Dica

    Antes de executar esses comandos Git, salve azure-pipelines.yml.

    git add azure-pipelines.yml
git commit -m "Add publish tasks"
git push origin build-pipeline

  3. Como você fez anteriormente, no Azure Pipelines, rastreie o build por meio de cada uma das etapas.

  4. Quando o pipeline for concluído, volte para o resumo do build.

  5. Em Related, há 1 published.

    Screenshot of the build summary. Details include the repository and version, the time started and elapsed, and a link to the published build artifact.

  6. Selecione o artefato.

  7. Expanda a pasta de destino.

    Você verá um arquivo .zip que contém seu aplicativo compilado e as dependências dele:

    Screenshot of the packaged web application in the Artifacts explorer.

    Se quiser experimentar um exercício opcional, baixe esse arquivo .zip no computador e explore o conteúdo dele.

Definir as variáveis para melhorar a legibilidade

Clara recua para examinar seu trabalho. A configuração de build faz o que ela precisa, mas ela deseja garantir que Paulo e outras pessoas possam ajudar a mantê-la atualizado e estendê-la com facilidade.

As variáveis permitem que você defina valores uma vez e referencie esses valores em todo o pipeline. O Azure Pipelines substitui cada variável pelo valor atual dela quando o pipeline é executado.

Assim como ocorre com outras linguagens de programação, as variáveis permitem fazer coisas como:

  • Defina os valores que podem ser alterados entre as execuções de seu pipeline.
  • Armazenar informações que são repetidas em todo o pipeline, como um número de versão ou um caminho de arquivo, em um só lugar. Dessa forma, você não precisará atualizar todas as ocorrências quando suas necessidades mudarem.

O Azure Pipelines fornece muitas variáveis internas. Essas variáveis descrevem aspectos do processo de build, como o identificador de build e os nomes de diretório em que o software é criado e preparado.

Você também pode definir suas próprias variáveis. Veja a seguir um exemplo que mostra uma variável chamada buildConfiguration que define a configuração do Build de lançamento:

variables:
  buildConfiguration: 'Release'

Use variáveis quando repetir o mesmo valor várias vezes ou quando um valor, como uma versão de dependência, puder ser alterado.

Você não precisa criar uma variável para cada parte da configuração de build. Na verdade, o excesso de variáveis pode dificultar a leitura e a compreensão do código do pipeline por outras pessoas.

Reserve alguns minutos para examinar azure-pipelines.yml. Observe que estes valores são repetidos:

  • Configuração de build: Release.
  • Local do diretório wwwroot: Tailspin.SpaceGame.Web/wwwroot.
  • Versão do SDK do .NET: 6.x.

Agora você usa variáveis para definir esses valores uma vez. Em seguida, você referencia as variáveis em todo o pipeline.

  1. No Visual Studio Code, altere o azure-pipelines.yml como você vê aqui:

    trigger:
- '*'

pool:
  name: 'Default' #replace if needed with name of your agent pool

variables:
  buildConfiguration: 'Release'
  wwwrootDir: 'Tailspin.SpaceGame.Web/wwwroot'
  dotnetSdkVersion: '6.x'

steps:
- task: UseDotNet@2
  displayName: 'Use .NET SDK $(dotnetSdkVersion)'
  inputs:
    version: '$(dotnetSdkVersion)'

- task: Npm@1
  displayName: 'Run npm install'
  inputs:
    verbose: false

- script: './node_modules/.bin/node-sass $(wwwrootDir) --output $(wwwrootDir)'
  displayName: 'Compile Sass assets'

- task: gulp@1
  displayName: 'Run gulp tasks'

- script: 'echo "$(Build.DefinitionName), $(Build.BuildId), $(Build.BuildNumber)" > buildinfo.txt'
  displayName: 'Write build info'
  workingDirectory: $(wwwrootDir)

- task: DotNetCoreCLI@2
  displayName: 'Restore project dependencies'
  inputs:
    command: 'restore'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Build the project - $(buildConfiguration)'
  inputs:
    command: 'build'
    arguments: '--no-restore --configuration $(buildConfiguration)'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Publish the project - $(buildConfiguration)'
  inputs:
    command: 'publish'
    projects: '**/*.csproj'
    publishWebProjects: false
    arguments: '--no-build --configuration $(buildConfiguration) --output $(Build.ArtifactStagingDirectory)/$(buildConfiguration)'
    zipAfterPublish: true

- task: PublishBuildArtifacts@1
  displayName: 'Publish Artifact: drop'
  condition: succeeded()

    trigger:
- '*'

pool:
  vmImage: ubuntu-latest

variables:
  buildConfiguration: 'Release'
  wwwrootDir: 'Tailspin.SpaceGame.Web/wwwroot'
  dotnetSdkVersion: '6.x'

steps:
- task: UseDotNet@2
  displayName: 'Use .NET SDK $(dotnetSdkVersion)'
  inputs:
    version: '$(dotnetSdkVersion)'

- task: Npm@1
  displayName: 'Run npm install'
  inputs:
    verbose: false

- script: './node_modules/.bin/node-sass $(wwwrootDir) --output $(wwwrootDir)'
  displayName: 'Compile Sass assets'

- task: gulp@1
  displayName: 'Run gulp tasks'

- script: 'echo "$(Build.DefinitionName), $(Build.BuildId), $(Build.BuildNumber)" > buildinfo.txt'
  displayName: 'Write build info'
  workingDirectory: $(wwwrootDir)

- task: DotNetCoreCLI@2
  displayName: 'Restore project dependencies'
  inputs:
    command: 'restore'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Build the project - $(buildConfiguration)'
  inputs:
    command: 'build'
    arguments: '--no-restore --configuration $(buildConfiguration)'
    projects: '**/*.csproj'

- task: DotNetCoreCLI@2
  displayName: 'Publish the project - $(buildConfiguration)'
  inputs:
    command: 'publish'
    projects: '**/*.csproj'
    publishWebProjects: false
    arguments: '--no-build --configuration $(buildConfiguration) --output $(Build.ArtifactStagingDirectory)/$(buildConfiguration)'
    zipAfterPublish: true

- task: PublishBuildArtifacts@1
  displayName: 'Publish Artifact: drop'
  condition: succeeded()

    Observe a seção variables, que define estas variáveis:

    • buildConfiguration: especifica a configuração de build.
    • wwwrootDir: especifica o caminho para o diretório wwwroot.
    • dotnetSdkVersion: especifica a versão do SDK do .NET a ser usada.

    Para referenciar essas variáveis, use a sintaxe $() como você faz com as variáveis internas. Veja a seguir a etapa que executa node-Sass para converter arquivos Sass em CSS. Para obter o caminho para o diretório wwwroot, ela referencia a variável wwwrootDir.

    - script: './node_modules/.bin/node-sass $(wwwrootDir) --output $(wwwrootDir)'
  displayName: 'Compile Sass assets'

    O comando de script usa essa variável para definir o diretório de origem para os arquivos Sass e o diretório no qual os arquivos CSS serão gravados. Ele também usa essa variável para definir o nome da tarefa mostrado na interface do usuário.

  2. No terminal integrado, adicione azure-pipelines.yml ao índice, confirme a alteração e envie a alteração por push ao GitHub.

    git add azure-pipelines.yml
git commit -m "Refactor common variables"
git push origin build-pipeline

  3. No Azure Pipelines, rastreie o build por meio de cada uma das etapas.

    Você verá que as variáveis serão substituídas por seus valores quando o build for executado. Por exemplo, esta é a tarefa UseDotNet@2 que define a versão do SDK do .NET a ser usada.

    Screenshot of Azure Pipelines showing the .NET SDK task running in the pipeline.

    Como antes, para ver o artefato quando o build for concluído, navegue até o resumo do build.

Parabéns! Você usou o Azure Pipelines com êxito e criou seu primeiro artefato de compilação.