From bec8ffed0d94005f38b39dbe88c4d72fca339962 Mon Sep 17 00:00:00 2001 From: ciceroff Date: Fri, 13 Sep 2024 17:33:32 -0300 Subject: [PATCH] =?UTF-8?q?adiciona=20manual=20de=20instala=C3=A7=C3=A3o?= =?UTF-8?q?=20action?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/manual-de-instalacao/action.md | 55 +++++++++++++++++++++++++++++ docs/post-mortem/post-mortem.md | 4 +-- mkdocs.yml | 3 +- 3 files changed, 59 insertions(+), 3 deletions(-) create mode 100644 docs/manual-de-instalacao/action.md diff --git a/docs/manual-de-instalacao/action.md b/docs/manual-de-instalacao/action.md new file mode 100644 index 0000000..1b535d6 --- /dev/null +++ b/docs/manual-de-instalacao/action.md @@ -0,0 +1,55 @@ +# Action + +## Pré-requisitos + +- Ter uma conta no GitHub. [Crie uma gratuitamente agora](https://github.com/signup) caso ainda não possua! +- O repositório para análise está configurado no MeasureSoftGram. +- Ter uma release em andamento criado no [web](https://2023-1-measure-soft-gram-front.vercel.app/) +- Ter um token de acesso ao MeasureSoftGram. [Crie um gratuitamente agora](https://2023-1-measure-soft-gram-front.vercel.app/) caso ainda não possua! + +## Uso + +Para utilizar o MeasureSoftGram no seu repositório GitHub, crie um novo fluxo de trabalho do GitHub Actions (por exemplo, `msgram-analysis.yml`) no diretório `.github/workflows`. No novo arquivo, insira o seguinte código: + +Caso você queira coletar as métricas do github passando a flag `collectGithubMetrics`, é importante que seu workflow seja disparado ao completar o worflow de build utilizado na sua Release. Só assim será possível que a métrica de tempo de feedback da build da Release seja corretamente persistida. + +```yaml +name: MeasureSoftGram + +on: + workflow_run: + workflows: ["nome_do_seu_worflow_de_build"] + types: + - completed +jobs: + msgram_job: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Action MeasureSoftGram + uses: fga-eps-mds/2023-1-MeasureSoftGram-Action@v2.1 + id: msgram + with: + githubToken: ${{ secrets.GITHUB_TOKEN }} # Token do GitHub + sonarProjectKey: "" # (opcional) Chave do projeto no SonarQube + msgramServiceToken: ${{ secrets.MSGRAM_SERVICE_TOKEN }} # Token para acessar o serviço MeasureSoftGram + productName: "" # Nome do produto + workflowName: 'nome_do_seu_worflow_de_build' # Nome do seu worflow que realiza a build da release + usLabel: "US" # Label usada para se referir a Histórias de Usuário no seu projeto +``` + +## Entradas + +| entrada | obrigatório | descrição | +| ------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `githubToken` | sim | Token do GitHub. Mais informações em [Token do GitHub](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret) | +| `sonarProjectKey` | não | Chave do projeto no SonarQube. A chave padrão é coletada a partir das informações coletadas do repositorio no github '\_'. | +| `msgramServiceToken` | sim | Token para acessar o serviço MeasureSoftGram | +| `productName` | sim | Nome do produto | +| `workflowName` | não | Nome do do worflow de build da release | +| `collectSonarqubeMetrics` | sim | Determina se serão coletadas métricas do Sonarqube | +| `collectGithubMetrics` | sim | Determina se serão coletadas métricas do Github | +| `usLabel` | não | Label usada para se referir a Histórias de Usuário no seu projeto | + +Lembre-se que é necessário que você disponha do seu token do GitHub para executar o MeasureSoftGram. Recomendamos o uso dos [Segredos do GitHub](https://docs.github.com/pt/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) para armazenar estas credenciais de forma segura. diff --git a/docs/post-mortem/post-mortem.md b/docs/post-mortem/post-mortem.md index 6cf81d6..fcb796e 100644 --- a/docs/post-mortem/post-mortem.md +++ b/docs/post-mortem/post-mortem.md @@ -1,10 +1,10 @@ # Introdução -O post mortem é uma análise final de um projeto após sua conclusão. O objetivo é revisar os sucessos, desafios, lições aprendidas e identificar pontos pendentes que podem ser desenvolvidos em iterações futuras. No contexto acadêmico, ele também serve para fornecer uma base sólida para que futuros estudantes ou equipes possam continuar o trabalho, evitando a repetição de erros e aprimorando o desenvolvimento. +O _post mortem_ é uma análise final de um projeto após sua conclusão. O objetivo é revisar os sucessos, desafios, lições aprendidas e identificar pontos pendentes que podem ser desenvolvidos em iterações futuras. No contexto acadêmico, ele também serve para fornecer uma base sólida para que futuros estudantes ou equipes possam continuar o trabalho, evitando a repetição de erros e aprimorando o desenvolvimento. # Análise da equipe -A equipe, no geral, se sentiu bastante desafiada com a proposta diferente do projeto. A maioria estava acostumada a trabalhar em projetos mais tradicionais, como sistemas de CRUD, onde as operações são claras e diretas. No entanto, com o MeasureSoftGram, a ideia de coletar medidas de repositórios e dados específicos, e não apenas gerenciar registros, trouxe uma nova dinâmica para o desenvolvimento. +A equipe, no geral, se sentiu bastante desafiada com a proposta diferente do projeto. A maioria estava acostumada a trabalhar em projetos mais tradicionais, como sistemas de CRUD, onde as operações são claras e diretas. No entanto, com o MeasureSoftwareGram, a ideia de coletar medidas de repositórios e dados específicos, e não apenas gerenciar registros, trouxe uma nova dinâmica para o desenvolvimento. # Pontos Pendentes diff --git a/mkdocs.yml b/mkdocs.yml index f9c7184..58f9df2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,7 @@ repo_name: "2024.1-MeasureSoftGram-DOC" repo_url: "https://github.com/fga-eps-mds/2024.1-MeasureSoftGram-DOC" theme: - name: material + name: mkdocs language: "pt" logo: "assets/logo.svg" favicon: "assets/logo.svg" @@ -39,5 +39,6 @@ nav: - Manual de instalação: - Service: manual-de-instalacao/service.md - Front: manual-de-instalacao/front.md + - Action: manual-de-instalacao/action.md - Post-Mortem: post-mortem/post-mortem.md