Action

Pré-requisitos

• Ter uma conta no GitHub. Crie uma gratuitamente agora caso ainda não possua!
• O repositório para análise está configurado no MeasureSoftGram.
• Ter uma release em andamento criado no web
• Ter um token de acesso ao MeasureSoftGram. Crie um gratuitamente agora 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.

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
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 para armazenar estas credenciais de forma segura.