Atualizando o arquivo README

parrera · Aug 24, 2023 · f43e61e · f43e61e
1 parent feab742
commit f43e61e
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 35 deletions.
diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml
@@ -1,9 +1,6 @@
 name: experiment-ci-cd #Nome do workflow
 on:
-  push:
-    branches:
-      - main #Executar quando houver um push na branch main
-  pull_request:
+  pull_request: #Executar quando houver um pull request na branch main
     branches:
       - main
 jobs: #Define os 3 Jobs que serão executados no workflow
@@ -51,23 +48,22 @@ jobs: #Define os 3 Jobs que serão executados no workflow
         with:
           files: test/test.xml #Arquivo com os resultados dos testes
 
-  #delivery:
-  #  runs-on: ubuntu-latest
-  #  permissions:
-  #    contents: write
-  #  needs: [test] #Este job depende do job "test"
-  #  steps:
-  #    - name: Repo checkout
-  #      uses: actions/checkout@v3 #Clona o repositório do GitHub
-
-  #    - name: Download artifacts
-  #      uses: actions/download-artifact@v3 #Baixa os artefatos gerados no job "build"
-  #      with:
-  #        name: experiment-ci-cd
+  delivery:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    needs: [test] #Este job depende do job "test"
+    steps:
+      - name: Repo checkout
+        uses: actions/checkout@v3 #Clona o repositório do GitHub
 
-      #- name: Create release
-      #  uses: ncipollo/[email protected] #Action para criar release
-      #  with:
-      #    artifacts: "experiment-ci-cd.bin" #Artefato que será criado na release
-      #    tag: 0.1.3 #Tag do release
-      #    bodyFile: "body.md" #Arquivo contendo o corpo do release
+      - name: Download artifacts
+        uses: actions/download-artifact@v3 #Baixa os artefatos gerados no job "build"
+        with:
+          name: experiment-ci-cd
+      - name: Create release
+        uses: ncipollo/[email protected] #Action para criar release
+        with:
+          artifacts: "experiment-ci-cd.bin" #Artefato que será criado na release
+          tag: 0.1.4 #Tag do release
+          bodyFile: "body.md" #Arquivo contendo o corpo do release
diff --git a/README.md b/README.md
@@ -112,12 +112,6 @@ git add --all
 git commit -m "Configurando GitHub Actions"
 git push origin main
 ```
-#### Passo 4
-
-Quando o `push` chegar no repositório principal, o GHA iniciará automaticamente o fluxo de tarefas configurado no arquivo `experiment-ci-cd.yml`.
-
-Você pode acompanhar o status dessa execução clicando na aba Actions do seu repositório.
-
 
 ## Tarefa #2: Criando um Pull Request (PR) com bug
 
@@ -147,7 +141,7 @@ git push origin bug
 
 Em seguida, crie um Pull Request (PR) com sua modificação. Para isso, basta acessar a seguinte URL em seu navegador: `https://github.com/<USER>/experiment-ci-cd/compare/main...bug`, onde `<USER>` deve ser substituído pelo seu usuário no GitHub. Nessa janela, você pode conferir as modificações feitas e incluir uma pequena descrição no PR.
 
-Após finalizar a criação do PR, será iniciada a pipeline, ou seja, o próprio GH vai fazer o build do sistema e rodar seus testes (como na tarefa #1). Porém, dessa vez os testes não vão passar, como você poderá ver na tela que aparecerá.
+Após finalizar a criação do PR, será iniciada a pipeline, ou seja, o GHA iniciará automaticamente o fluxo de tarefas configurado no arquivo `experiment-ci-cd.yml`. Porém, dessa vez os testes não vão passar, como você poderá ver na tela que aparecerá. Você pode acompanhar o status dessa execução clicando na aba Actions do seu repositório.
 
 Em suma, o Servidor CI/CD conseguiu alertar, de forma automática, tanto o autor do PR como o integrador de que existe um problema no código submetido, o que impede que ele seja integrado no branch principal do repositório.
 
@@ -162,17 +156,17 @@ Test(suite_name, test_name){
 ```
 Em seguida, crie novamente um Pull Request (PR) com sua correção. Para isso, basta acessar a seguinte URL em seu navegador: `https://github.com/<USER>/experiment-ci-cd/compare/main...bug`, onde `<USER>` deve ser substituído pelo seu usuário no GitHub. Nessa janela, você pode conferir as modificações feitas e incluir uma pequena descrição no PR.
 
-Após finalizar a criação do PR, será iniciada novamente a pipeline, ou seja, o próprio GH vai fazer o build do sistema, rodar o teste e realizará a entrega do artefato criando uma Release do seu projeto. Você conseguirá ver o andamento detalhado deste seu pipeline clicando na aba Actions e no nome que deu ao PR criado. Após criada, sua Release está disponível indo na página inicial deste seu projeto no canto direito da sua tela.
-
-Em suma, o Servidor CI/CD conseguiu alertar, de forma automática, tanto o autor do PR como o integrador de que existe um problema no código submetido, o que impede que ele seja integrado no branch principal do repositório.
-
+Após finalizar a criação do PR, será iniciada novamente a pipeline, ou seja, o próprio GHA vai fazer o build do sistema, rodar o teste e realizará a entrega do artefato criando uma Release do seu projeto. Você conseguirá ver o andamento detalhado deste seu pipeline clicando na aba Actions. Após criada, sua Release está disponível na página inicial deste seu projeto no canto direito da sua tela.
 
 #### Esquemático do protótipo: [prototype.pdf](https://github.com/parrera/experiment-ci-cd/files/12381438/prototype.pdf)
 
-*Para deploy*:
+*Para deploy no protótipo*:
 
 ```bashBa
 $get_idf
 $idf.py build
 $idf.py -p /dev/ttyUSB0 flash monitor
 ```
+
+*Passo-a-passo de configuração e instalação do ambiente ESP-IDF em uma distribuição GNU/Linux*: `https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html`
+