Use essa action do GitHub para realizar uma análise de código com o MeasureSoftGram. A ferramenta gera resultados de análise de código, que são enviador ao servidor web e mostrado em formas de graficos quando seus pull requests para a main (ou branch escolhida) sejam fechados.
O MeasureSoftGram é uma ferramenta robusta para gestão e avaliação de qualidade de software. Ele suporta múltiplos atributos de qualidade e retorna métricas analisadas de software com base em modelos algébricos. O MeasureSoftGram é completamente gratuito para projetos open-source.
- 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 criada na interface web.
- Ter um token de acesso ao MeasureSoftGram (pode ser gerado na interface web).
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| 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 '<proprietário do repositorio>_<nome do repositório>'. |
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.
Os resultados são adicionados ao website do MeasureSoftwareGram e exibidos nesse gráfico:
Estamos sempre trabalhando para melhorar e expandir as capacidades do MeasureSoftGram. Aqui estão algumas atualizações planejadas:
- Persistência dos resultados: Em futuras atualizações, planejamos permitir o armazenamento dos resultados gerados pelo calculo da action na nossa aplicação web.
- Configurações personalizáveis: Planejamos permitir que o usuário altere as configurações a partir do input da action.
- Expansão da integração do Parser: O parser irá expandir sua integração com ferramentas de análise para além do SonarQube.
- Badges no README: Planejamos adicionar uma funcionalidade que permitirá aos usuários exibir badges com métricas no README do seu repositório. Com isso, você poderá fornecer uma visão rápida da qualidade do software diretamente no seu README.