Versionamento¶

Exercício: Versionar Mudanças Adicionadas ao Branch Principal¶

Versionamento Semântico, semver, é um esquema que transmite significado sobre o código subjacente e o que foi modificado de uma versão para a próxima.

A versão 2.0.0 do semver é oficialmente resumida da seguinte forma:

Dado um número de versão MAJOR.MINOR.PATCH, incremente o:

1. Número de versão MAJOR quando fizer mudanças incompatíveis na API
2. Número de versão MINOR quando adicionar funcionalidades de maneira compatível com versões anteriores
3. Número de versão PATCH quando fizer correções de bugs compatíveis com versões anteriores

Rótulos adicionais para pré-lançamento e metadados de compilação estão disponíveis como extensões ao formato MAJOR.MINOR.PATCH.

Nesta fase fundamental da implementação de DevSecOps, aplicaremos o esquema semver e automatizaremos o incremento do patch. Existem convenções que podem ser adotadas para automatizar igualmente o incremento nas versões MAJOR e MINOR, mas para simplificar, nossa implementação pretendida assume o entendimento de que os aumentos de versão MAJOR e MINOR serão iniciados manualmente.

Implementar Versionamento de PATCH¶

No explorador de arquivos, crie um novo fluxo de trabalho .github/workflows/continuous.versioning.yml da seguinte forma:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

name: Version Changes to the Main Branch

on:
  push:
    branches:
      - main
  workflow_dispatch: {}

jobs:
  version-main-branch-changes:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/create-github-app-token@v1
        id: generate-app-token
        with:
          app-id: ${{ vars.APP_ID_ACTIONS_ASSISTANT }}
          private-key: ${{ secrets.APP_PRIVATE_KEY_ACTIONS_ASSISTANT }}

      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0
          token: ${{ steps.generate-app-token.outputs.token }}

      - name: Get last version number
        id: get_last_version
        run: |
          # Retrieve the last git tag, as we will only be processing one delivery line.
          last_version=$(git describe --tags --abbrev=0 2>/dev/null || echo "0.0.0")
          echo "Last version is $last_version"
          echo "last_version=$last_version" >> "$GITHUB_OUTPUT"

      - name: Get new version number
        id: get_new_version
        run: |
          major=$(echo $last_version | cut -d. -f1)
          minor=$(echo $last_version | cut -d. -f2)
          patch=$(echo $last_version | cut -d. -f3)

          new_patch=$((patch+1))

          new_version="$major.$minor.$new_patch"

          echo "New version is $new_version"
          echo "new_version=$new_version" >> "$GITHUB_OUTPUT"
        env:
          last_version: ${{ steps.get_last_version.outputs.last_version }}

      - name: Create tag for the new version
        run: |
          git config --global user.name "${GITHUB_ACTOR}"
          git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"

          if git tag -a "$new_version" -m "Version $new_version"; then
            git push --follow-tags origin "$new_version"
          else
            echo "Failed to create tag $new_version, it probably already exists"
          fi
        env:
          new_version: ${{ steps.get_new_version.outputs.new_version }}-release

Análise¶

• Linhas 4 - 6

  Somos introduzidos a um novo evento que encapsula a atividade de envio para branches específicos, especificamente apenas o branch main nesta implementação.

• Linhas 13 - 17

  Um GitHub App será usado como o ator para as operações que executaremos. Portanto, a ação actions/create-github-app-token@v1 é usada aqui para gerar um token de autorização para o aplicativo.

  O que é um GitHub App?

  GitHub Apps, muito semelhantes a contas de serviço e bots, são ferramentas que estendem a funcionalidade do GitHub. Você pode criar um GitHub App para fornecer flexibilidade e reduzir atrito em seus processos, sem precisar fazer login como usuário ou criar uma conta de serviço . GitHub Apps podem fazer coisas no GitHub como abrir issues, comentar em pull requests e gerenciar projetos. Eles também podem fazer coisas fora do GitHub com base em eventos que acontecem no GitHub. Por exemplo, um GitHub App pode postar no Slack quando uma issue é aberta no GitHub.

  O ator GitHub App será usado posteriormente para fazer checkout do código-fonte do repositório e para enviar tags.

• Linhas 25 - 31

  A etapa Get last version number (Obter último número de versão) calcula a última versão e a escreve na saída da etapa chamada last_version.

• Linhas 33 - 47

  A etapa Get new version number (Obter novo número de versão) lê a saída da etapa anterior pela expressão ${{ steps.get_last_version.outputs.last_version }} e a usa para calcular o incremento do patch.

• Linhas 49 - 60

  A etapa Create tag for the new version (Criar tag para a nova versão) cria uma nova tag git para o lançamento. Uma tag identifica pontos específicos no histórico de um repositório como sendo importantes. Aqui, a tag está sendo usada para marcar um ponto de lançamento.

  Como existe um token de aplicativo persistente que será usado no envio da tag, podemos ter confiança de que o envio acionará efetivamente outras automações relevantes. Por outro lado, se o GITHUB_TOKEN padrão fosse usado, ele não acionaria um fluxo de trabalho, pois GitHub Actions corretamente protege contra o acionamento recursivo não intencional de fluxos de trabalho .

Fazer commit e publicar suas alterações¶

1
2
3

git add .
git commit -m "$(printf 'Criar um jogo de tetris para impulsionar o engajamento do site\n\n-Implementar versionamento automático de patch\n\n- Resolve #<NÚMERO-DA-ISSUE>')"
git push origin feature/tetris-game

📚 Recursos¶

• Versionamento Semântico 2.0.0