Exercício – Proteger sua ramificação principal

5 minutos

Sua equipe está trabalhando em um modelo Bicep que já contém um site e um banco de dados. Você implantou os componentes em seu ambiente de produção. Agora, você precisa atualizar seu modelo Bicep para adicionar a fila de processamento de pedidos.

Neste exercício, você criará uma ramificação de recurso para sua alteração. Você também protegerá a ramificação principal e permitirá que as alterações sejam mescladas somente à ramificação principal após terem sido revisadas. No entanto, antes disso, verifique se o ambiente está configurado para concluir o restante deste módulo.

Durante o processo, você vai:

Configure um repositório GitHub para este módulo.
Clone o repositório para o seu computador.
Adicione a proteção de ramificação à ramificação principal do repositório.
Crie uma ramificação de recurso local para sua alteração.
Tente mesclar à ramificação de recursos à principal.

Configure um projeto do Azure DevOps para este módulo.
Clonar o repositório do projeto no computador.
Adicione políticas de ramificação à ramificação principal do repositório.
Crie uma ramificação de recurso local para sua alteração.
Tente mesclar à ramificação de recursos à principal.

Obter o repositório GitHub

Aqui, você se certifica de que o repositório GitHub está configurado para concluir o restante deste módulo. Você o configura criando um repositório com base em outro de modelo. O repositório de modelo contém os arquivos necessários para prosseguir neste módulo.

Começar com o repositório de modelo

Execute um modelo que configura seu repositório GitHub.

Executar o modelo

No site do GitHub, siga estas etapas para criar um repositório com base no modelo:

Selecione Usar este modelo>Criar um repositório.
Digite um nome para seu novo projeto, como toy-website-review.
Selecione a opção Público.

Ao criar seus repositórios, você pode querer torná-los privados. Neste módulo, você trabalhará com recursos do GitHub que funcionam somente com repositórios públicos e contas do GitHub Enterprise.
Selecione Criar repositório com base no modelo.

Obter o projeto do Azure DevOps

Aqui, você verificará se a sua organização do Azure DevOps está preparada para concluir o restante deste módulo. Você a prepara executando um modelo que cria um projeto no Azure DevOps.

Executar o modelo

No site Gerador de Demonstração do Azure DevOps, siga estas etapas:

Selecione Sign In e aceite os termos de uso.
Na página Create New Project, selecione a sua organização do Azure DevOps. Insira um nome de projeto, como toy-website-review.
Selecione Create Project.

O modelo leva alguns minutos para ser executado. Ele cria automaticamente um pipeline e um arquivo Bicep que você usará em exercícios posteriores.
Selecione Navigate to project para acessar o seu projeto no Azure DevOps.

Clonar o repositório

Agora você tem uma cópia do repositório de modelo na sua conta. Clone este repositório localmente para começar a trabalhar nele.

Selecione Código e escolha o ícone de Copiar.
Abra o Visual Studio Code.
Abra uma janela do terminal do Visual Studio Code selecionando Terminal>Novo Terminal. Geralmente, a janela é aberta na parte inferior da tela.
No terminal, vá para o diretório em que você deseja clonar o repositório do GitHub no computador local. Por exemplo, para clonar o repositório para a pasta toy-website-review, execute o seguinte comando:
```
cd toy-website-review
```
Digite git clone, cole a URL que você copiou anteriormente e execute o comando. O comando se parece com o seguinte:
```
git clone https://github.com/mygithubuser/toy-website-review.git
```
Reabra o Visual Studio Code na pasta do repositório executando o seguinte comando no terminal do Visual Studio Code:
```
code -r toy-website-review
```

Agora você tem um projeto em sua conta. Clone este repositório localmente para começar a trabalhar nele.

Selecione Repos>Arquivos.
Selecione Clonar.
Se você estiver usando o macOS, precisará de uma senha especial para clonar o repositório Git. Selecione Gerar credenciais do Git e copie o nome de usuário e a senha exibidos para um local seguro.
Selecione Clonar no VS Code. Se um prompt aparecer solicitando a abertura do Visual Studio Code, selecione Abrir.
Crie uma pasta a ser usada para o repositório e escolha Selecionar Local do Repositório.
Você está usando esse repositório pela primeira vez, portanto, será solicitado que você entre.
- Se estiver usando Windows, insira as mesmas credenciais que usou para entrar no Azure DevOps anteriormente neste exercício.
- Se você estiver usando o macOS, insira o nome de usuário e a senha do Git que você gerou há alguns instantes.
O Visual Studio Code solicita que você abra o repositório. Selecione Abrir.

Adicionar proteções de ramificação

Configure seu repositório Git para impedir envios diretos para a ramificação principal.

No navegador, selecione Configurações.
Selecione Ramificações.
Selecione Adicionar regra de proteção de branch.
Na caixa de texto Padrão do nome da ramificação, insira principal.
Selecione Exigir uma solicitação de pull antes de mesclar.

Desmarque Exigir aprovações. Normalmente, você selecionaria essa opção. Mas neste exemplo você mesclará sua própria solicitação de pull e a opção Exigir aprovações impedirá isso.
Selecione Não permitir ignorar as configurações acima.

Você seleciona essa configuração como um exemplo para mostrar como git push para main falha posteriormente neste exercício. Em um ambiente de produção, talvez você não queira restringir mesclagens diretas para main para administradores ou proprietários de repositórios.
Na parte inferior da página, selecione Criar.

O GitHub pode solicitar que você entre novamente para confirmar sua identidade.

Adicionar políticas de ramificação

Configure seu repositório Git para impedir envios diretos para a ramificação principal.

No navegador, acesse Repositório>Ramificações.
Passe o mouse sobre a ramificação principal e selecione os três pontos.
Selecione Políticas de ramificação.
Na janela Políticas de ramificação, altere a configuração Exigir um número mínimo de revisores para Ativado.
Altere o número mínimo de revisores para 1 e selecione a opção Permitir que os solicitantes aprovem suas próprias alterações.

Observação

Aqui, você habilita a opção Permitir que os solicitantes aprovem suas próprias alterações. Nestes exercícios, você trabalhará por conta própria. Portanto, precisa criar e aprovar suas alterações. Mas em um ambiente de equipe real, talvez você não queira habilitar essa opção.

Criar uma ramificação de recurso local

No terminal do Visual Studio Code, execute a seguinte instrução:
```
git checkout -b add-orders-queue
```
Este comando cria uma nova ramificação de recursos para você trabalhar.
Abra o arquivo main.bicep na pasta deploy.

Abaixo dos parâmetros, adicione uma nova variável para o nome da fila:

var storageAccountSkuName = (environmentType == 'prod') ? 'Standard_GRS' : 'Standard_LRS'
var processOrderQueueName = 'processorder'

No recurso da conta de armazenamento, adicione a fila como um recurso filho aninhado:

resource storageAccount 'Microsoft.Storage/storageAccounts@2022-09-01' = {
  name: storageAccountName
  location: location
  sku: {
    name: storageAccountSkuName
  }
  kind: 'StorageV2'
  properties: {
    accessTier: 'Hot'
  }

  resource queueServices 'queueServices' existing = {
    name: 'default'

    resource processOrderQueue 'queues' = {
      name: processOrderQueueName
    }
  }
}

Na definição do módulo appService, adicione os nomes da conta de armazenamento e da fila como parâmetros:

module appService 'modules/appService.bicep' = {
  name: 'appService'
  params: {
    location: location
    appServiceAppName: appServiceAppName
    storageAccountName: storageAccount.name
    processOrderQueueName: storageAccount::queueServices::processOrderQueue.name
    environmentType: environmentType
  }
}

Esse código permite que o aplicativo encontre a fila para a qual ele enviará mensagens.

Salve o arquivo main.bicep.
Abra o arquivo appService.bicep na pasta deploy/modules.

Próximo à parte superior do arquivo appService.bicep, adicione novos parâmetros para os nomes da conta de armazenamento e da fila:

@description('The Azure region into which the resources should be deployed.')
param location string

@description('The name of the App Service app to deploy. This name must be globally unique.')
param appServiceAppName string

@description('The name of the storage account to deploy. This name must be globally unique.')
param storageAccountName string

@description('The name of the queue to deploy for processing orders.')
param processOrderQueueName string

@description('The type of the environment. This must be nonprod or prod.')
@allowed([
  'nonprod'
  'prod'
])
param environmentType string

Atualize o recurso appServiceApp para propagar os nomes da conta de armazenamento e da fila para as variáveis de ambiente do aplicativo:

resource appServiceApp 'Microsoft.Web/sites@2022-03-01' = {
  name: appServiceAppName
  location: location
  properties: {
    serverFarmId: appServicePlan.id
    httpsOnly: true
    siteConfig: {
      appSettings: [
        {
          name: 'StorageAccountName'
          value: storageAccountName
        }
        {
          name: 'ProcessOrderQueueName'
          value: processOrderQueueName
        }
      ]
    }
  }
}

Confirmar e efetuar push da sua ramificação do recurso

Faça commit e efetue push das alterações no repositório GitHub executando os seguintes comandos no terminal do Visual Studio Code:

Faça commit e efetue push das alterações no repositório do Azure Repos executando os seguintes comandos no terminal do Visual Studio Code:

git add .
git commit -m "Add orders queue and associated configuration"
git push --set-upstream origin add-orders-queue

O branch de recursos é enviado para uma nova ramificação, também chamado add-orders-queue, em seu repositório remoto.

Tente mesclar a ramificação de recursos com a principal

Você aprendeu por que não é aconselhável fazer push diretamente para a ramificação principal. Aqui, você tenta dividir essa diretriz para ver como a proteção da ramificação principal impede que você envie por push acidentalmente as alterações para uma ramificação protegida.

No terminal do Visual Studio Code, execute as seguintes instruções para alternar para a ramificação principal e mesclar a ramificação add-orders-queue nele:
```
git checkout main
git merge add-orders-queue
```
O comando funcionou, mas você mesclou a ramificação add-orders-queue em sua ramificação principal apenas no repositório Git local.

Execute a seguinte instrução para tentar fazer push das alterações para GitHub:

git push

Observe que o push falha com uma mensagem de erro semelhante a esta:

Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
remote: error: GH006: Protected branch update failed for refs/heads/main.
remote: error: Changes must be made through a pull request.
To https://github.com/mygithubuser/toy-website-review.git
 ! [remote rejected] main -> main (protected branch hook declined)
error: failed to push some refs to 'https://github.com/mygithubuser/toy-website-review.git'

A mensagem de erro informa que os pushes para a ramificação principal não são permitidos e que você deve usar uma solicitação de pull para atualizar a ramificação.

Desfaça a mesclagem executando a seguinte instrução:
```
git reset --hard HEAD~1
```
Esse comando informa ao repositório Git local para redefinir o estado da ramificação principal para o que era antes da última confirmação ser mesclada e não para salvar as alterações. A ramificação add-orders-queue não é afetada.

Você aprendeu por que não é aconselhável fazer push diretamente para a ramificação principal. Aqui, você tenta dividir essa diretriz para ver como as políticas de ramificação impedem que você envie por push acidentalmente as alterações para uma ramificação protegida.

No terminal do Visual Studio Code, execute as seguintes instruções para alternar para a ramificação principal e mesclar a ramificação add-orders-queue nele:
```
git checkout main
git merge add-orders-queue
```
O comando funcionou, mas você mesclou a ramificação add-orders-queue em sua ramificação principal apenas no repositório Git local.

Execute a seguinte instrução para tentar fazer push das alterações para Azure Repos:

git push