From 6bd9907b92cddea5edf773c51874e67b4e3aeb8e Mon Sep 17 00:00:00 2001 From: Rodrigo de Oliveira Date: Sat, 31 Oct 2026 11:37:29 -0300 Subject: [PATCH 1/7] docs: surface published GitHub Action v1.0.0 in READMEs and release pages --- README.md | 34 +++++++++++++++++-- README.pt-BR.md | 34 +++++++++++++++++-- .../content/docs/pt-br/reference/releases.md | 8 +++++ .../src/content/docs/reference/releases.md | 8 +++++ 4 files changed, 80 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a0aa9b8..4bcbf9b 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The ecosystem has four integration surfaces: - `ComplexityAnalysis.Analyzers`: Roslyn diagnostics during builds and IDE analysis. - `ComplexityAnalysis.Tool`: a .NET CLI for reports, snapshots, comparison, duplicate detection, and opt-in quality gates. - `ComplexityAnalysis.Mcp`: a local, read-only MCP server for compatible AI tools. -- [Complexity Analysis Action](docs/en/github-action.md): a separately versioned GitHub Action for CI quality gates, JSON/SARIF reports, and pull-request regression checks. +- [Complexity Analysis Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0): a separately versioned GitHub Action for CI quality gates, JSON/SARIF reports, and pull-request regression checks. [Install it](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) or read the [technical guide](docs/en/github-action.md). The portal source and local development instructions live in [`website/`](website/README.md). @@ -40,6 +40,36 @@ dotnet add package ComplexityAnalysis.Analyzers The package works as a compile-time analyzer. After installation, Roslyn loads it during builds and IDE analysis; application code does not call the analyzer and does not take a runtime dependency on it. For local package creation and repository-based consumption, see [Getting Started](docs/en/getting-started.md). +## GitHub Action v1.0.0 + +The separately maintained [Complexity Analysis Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) was released on October 30, 2026. It runs the published CLI in GitHub Actions on supported Ubuntu runners; its version is independent of the Analyzer, CLI, and MCP versions. + +Add this workflow to `.github/workflows/complexity.yml` in the consuming repository and replace `MySolution.slnx` with your C# project or solution path: + +```yaml +name: Complexity Analysis + +on: + pull_request: + +permissions: + contents: read + +jobs: + complexity: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 + with: + persist-credentials: false + - name: Analyze complexity + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 + with: + path: MySolution.slnx +``` + +The example pins the reviewed `v1.0.0` commit for reproducibility. The published tag `@v1.0.0` is also available, but the moving `@v1` alias has not been verified. See the [Action installation instructions](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) and [release notes](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). + ## Quick example ```csharp @@ -376,7 +406,7 @@ See [Architecture](docs/en/architecture.md). - [C# Halstead Metrics](docs/en/halstead-metrics.md) - [Project-Level Tooling](docs/en/project-tooling.md) - [Local MCP Server](docs/en/mcp-server.md) -- [GitHub Action for CI and pull requests](docs/en/github-action.md) +- [GitHub Action v1.0.0 release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) and [installation](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) · [Technical guide](docs/en/github-action.md) - [Runnable sample](samples/ComplexityAnalysis.Sample/README.md) - [Release Quality Governance](docs/en/development/quality-gates.md) - [Documentação em português](README.pt-BR.md) diff --git a/README.pt-BR.md b/README.pt-BR.md index 173b99f..2a1135a 100644 --- a/README.pt-BR.md +++ b/README.pt-BR.md @@ -20,7 +20,7 @@ O ecossistema possui quatro formas de integração: - `ComplexityAnalysis.Analyzers`: diagnósticos Roslyn durante builds e análise na IDE. - `ComplexityAnalysis.Tool`: CLI .NET para relatórios, snapshots, comparação, detecção de duplicação e quality gates opt-in. - `ComplexityAnalysis.Mcp`: servidor MCP local e somente leitura para ferramentas de IA compatíveis. -- [Complexity Analysis Action](docs/pt-BR/github-action.md): GitHub Action com versionamento independente para quality gates no CI, relatórios JSON/SARIF e análise de regressões em PRs. +- [Complexity Analysis Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0): GitHub Action com versionamento independente para quality gates no CI, relatórios JSON/SARIF e análise de regressões em PRs. Veja a [instalação](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) ou o [guia técnico](docs/pt-BR/github-action.md). O código-fonte do portal e as instruções de desenvolvimento local ficam em [`website/`](website/README.md). @@ -40,6 +40,36 @@ dotnet add package ComplexityAnalysis.Analyzers O pacote funciona como um analyzer de tempo de compilação. Depois da instalação, o Roslyn o carrega durante builds e análise na IDE; o código da aplicação não chama o analyzer e não assume uma dependência de runtime nele. Para criação local do pacote e consumo a partir do repositório, veja [Primeiros Passos](docs/pt-BR/getting-started.md). +## GitHub Action v1.0.0 + +A [Complexity Analysis Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) foi publicada em 30 de outubro de 2026. Ela executa a CLI publicada no GitHub Actions, em runners Ubuntu suportados, e possui versionamento independente do Analyzer, da CLI e do MCP. + +Crie o workflow `.github/workflows/complexity.yml` no repositório consumidor e substitua `MySolution.slnx` pelo caminho do projeto ou solução C#: + +```yaml +name: Complexity Analysis + +on: + pull_request: + +permissions: + contents: read + +jobs: + complexity: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 + with: + persist-credentials: false + - name: Analyze complexity + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 + with: + path: MySolution.slnx +``` + +O exemplo utiliza o SHA revisado da `v1.0.0` para maior reprodutibilidade. A tag publicada `@v1.0.0` também está disponível, mas a referência móvel `@v1` ainda não foi verificada. Consulte as [instruções de instalação](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) e as [notas da release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). + ## Exemplo rápido ```csharp @@ -379,7 +409,7 @@ Veja [Arquitetura](docs/pt-BR/architecture.md). - [Métricas Halstead para C#](docs/pt-BR/halstead-metrics.md) - [Ferramentas em Nível de Projeto](docs/pt-BR/project-tooling.md) - [Servidor MCP Local](docs/pt-BR/mcp-server.md) -- [GitHub Action para CI e pull requests](docs/pt-BR/github-action.md) +- [Release da GitHub Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) e [instalação](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) · [Guia técnico](docs/pt-BR/github-action.md) - [Sample executável](samples/ComplexityAnalysis.Sample/README.md) - [Governança de Qualidade de Release](docs/pt-BR/development/quality-gates.md) - [Documentation in English](README.md) diff --git a/website/src/content/docs/pt-br/reference/releases.md b/website/src/content/docs/pt-br/reference/releases.md index 7deb418..5e3ac9f 100644 --- a/website/src/content/docs/pt-br/reference/releases.md +++ b/website/src/content/docs/pt-br/reference/releases.md @@ -9,6 +9,14 @@ Use as [GitHub Releases](https://github.com/rodri-oliveira-dev/complexity-analyz Os pacotes Analyzer, CLI e MCP são consumíveis de forma independente e podem ter evidências de publicação distintas. Uma versão citada na documentação-fonte só está disponível quando o pacote pode ser verificado no registro correspondente. +## GitHub Action v1.0.0 + +A [Complexity Analysis Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0), com versionamento independente, foi publicada em 30 de outubro de 2026. Consulte o [guia de instalação da Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) para adicioná-la a um workflow do GitHub Actions, ou leia as [notas da release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). + +A tag `@v1.0.0` aponta para o commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`. Para maior reprodutibilidade, utilize esse SHA completo em `uses:`. A referência móvel `@v1` ainda não foi verificada; confirme a existência da tag antes de utilizá-la. A existência da GitHub Release não comprova, por si só, a disponibilidade da listagem no Marketplace. + +A Action invoca `ComplexityAnalysis.Tool` e não substitui as versões independentes do Analyzer, da CLI ou do MCP. + Para detalhes da publicação MCP `1.0.0` e metadados do registro, consulte a [nota de release](/complexity-analyzers/pt-br/reference/releases/mcp-1-0-0/) sincronizada. O MCP `1.0.1` está preparado, mas ainda não foi publicado. Sua [nota diff --git a/website/src/content/docs/reference/releases.md b/website/src/content/docs/reference/releases.md index 7c38790..70e1be1 100644 --- a/website/src/content/docs/reference/releases.md +++ b/website/src/content/docs/reference/releases.md @@ -9,6 +9,14 @@ Use the repository's [GitHub Releases](https://github.com/rodri-oliveira-dev/com The Analyzer, CLI, and MCP packages are independently consumable and may have distinct publication evidence. A version mentioned in source documentation is not available until its package can be verified on the relevant registry. +## GitHub Action v1.0.0 + +The independently versioned [Complexity Analysis Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) was published on October 30, 2026. Use the [Action installation guide](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) to add it to a GitHub Actions workflow, or inspect the [release notes](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). + +The published `@v1.0.0` tag resolves to commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`. For reproducible automation, reference that full commit SHA in `uses:`. The moving `@v1` reference is not yet verified; do not rely on it without confirming the tag exists. The GitHub release alone does not establish Marketplace listing visibility. + +The Action invokes `ComplexityAnalysis.Tool` and does not replace the separately versioned Analyzer, CLI, or MCP packages. + For MCP `1.0.0` publication details and registry metadata, see the synchronized [release note](/complexity-analyzers/reference/releases/mcp-1-0-0/). MCP `1.0.1` is prepared but not yet published. Its synchronized [release From d5e762a9ca98c917a4ea9543be7dd55865997bba Mon Sep 17 00:00:00 2001 From: Rodrigo de Oliveira Date: Sat, 31 Oct 2026 11:49:00 -0300 Subject: [PATCH 2/7] docs: update CLI integration guides for published Action v1.0.0 --- docs/en/project-tooling.md | 19 ++++++- docs/pt-BR/project-tooling.md | 19 ++++++- .../src/content/docs/cli/github-actions.md | 56 +++++++++++++++++-- .../content/docs/pt-br/cli/github-actions.md | 56 +++++++++++++++++-- 4 files changed, 136 insertions(+), 14 deletions(-) diff --git a/docs/en/project-tooling.md b/docs/en/project-tooling.md index 30db7c6..589e7b9 100644 --- a/docs/en/project-tooling.md +++ b/docs/en/project-tooling.md @@ -306,4 +306,21 @@ those dependencies are not exposed to analyzer package consumers. ## GitHub Actions integration -For ready-to-use CI configuration built on this CLI, see the [GitHub Action guide](github-action.md). The separately maintained Action invokes the published CLI; it does not change metric semantics, quality-gate defaults, or snapshot comparison behavior. Action and CLI releases are independent. Do not assume the planned Action `v1.0.0` exists until it is publicly released. +For reusable GitHub CI analysis, use the separately maintained +[Complexity Analysis Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start). Its +[stable `v1.0.0` release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) +was published on 2026-10-30 and installs the exact published +`ComplexityAnalysis.Tool` version `1.0.1` by default. + +Choose the CLI directly for local execution or custom CI orchestration; choose +the Action for reusable GitHub Actions workflows with JSON/SARIF reporting, +opt-in quality gates, and pull-request regression comparison. Both invoke the +same analysis engine and preserve identical metric and snapshot semantics. +Their versions are independent of each other and of the Analyzer and MCP. + +For reproducibility, pin the Action to the reviewed `v1.0.0` release commit +`2d807ef29ca03c685d224543a135d8c30dfe2c67`; the published `@v1.0.0` tag is another +supported option. The moving `@v1` alias has not been created yet. See the +[GitHub Action guide](github-action.md) and +[published examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples) for +supported inputs and security considerations. diff --git a/docs/pt-BR/project-tooling.md b/docs/pt-BR/project-tooling.md index 312f571..385e7af 100644 --- a/docs/pt-BR/project-tooling.md +++ b/docs/pt-BR/project-tooling.md @@ -310,4 +310,21 @@ mas essas dependências não são expostas aos consumidores do pacote do analyze ## Integração com GitHub Actions -Para configurar o CI usando esta CLI, consulte o [guia da GitHub Action](github-action.md). A Action é mantida separadamente e invoca a CLI publicada; ela não altera as métricas, os padrões de quality gates nem a semântica da comparação de snapshots. As releases da Action e da CLI são independentes. Não considere a versão planejada `v1.0.0` como publicada antes de confirmar sua disponibilidade. +Para integrar a análise ao CI do GitHub sem manter scripts próprios, use a +[Complexity Analysis Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start). +Sua [release estável `v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) +foi publicada em 30/10/2026 e instala, por padrão, a versão exata publicada +`1.0.1` de `ComplexityAnalysis.Tool`. + +Use a CLI diretamente para execução local ou orquestração personalizada no CI; +prefira a Action para workflows reutilizáveis do GitHub Actions com relatórios +JSON/SARIF, quality gates opcionais e comparação de regressões em pull requests. +Ambas usam o mesmo motor de análise, preservando as métricas e a semântica dos +snapshots. O versionamento da Action é independente da CLI, do Analyzer e do MCP. + +Para maior reprodutibilidade, fixe a Action no commit revisado da `v1.0.0`, +`2d807ef29ca03c685d224543a135d8c30dfe2c67`; a tag publicada `@v1.0.0` +também está disponível. A referência móvel `@v1` ainda não foi criada. Consulte +o [guia da GitHub Action](github-action.md) e os +[exemplos publicados](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples) para +informações sobre inputs e segurança. diff --git a/website/src/content/docs/cli/github-actions.md b/website/src/content/docs/cli/github-actions.md index 21ed4b2..235e5dc 100644 --- a/website/src/content/docs/cli/github-actions.md +++ b/website/src/content/docs/cli/github-actions.md @@ -5,13 +5,18 @@ sidebar: order: 2 --- -This page shows a **manual CLI workflow**. If you prefer a reusable Action with built-in reports and PR regression options, see the [Complexity Analysis GitHub Action](/complexity-analyzers/action/). Its first stable release is planned but not yet published. +This page shows a **manual CLI workflow**. For reusable GitHub CI checks, +the [Complexity Analysis Action](/complexity-analyzers/action/) +is available in its [published `v1.0.0` release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). +It invokes the same CLI, but its release versions are independent. For adoption, +see the [installation guide](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) and the +[versioned examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). Use a repository-local tool manifest so the workflow restores a reviewed version. ```bash dotnet new tool-manifest -dotnet tool install ComplexityAnalysis.Tool --version 1.0.0 +dotnet tool install ComplexityAnalysis.Tool --version 1.0.1 ``` Commit `.config/dotnet-tools.json`, then invoke the tool in CI: @@ -29,12 +34,12 @@ jobs: analyze: runs-on: ubuntu-latest steps: - - uses: actions/checkout@ + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with: persist-credentials: false - - uses: actions/setup-dotnet@ + - uses: actions/setup-dotnet@a98b56852c35b8e3190ac28c8c2271da59106c68 with: - dotnet-version: '10.0.x' + dotnet-version: '10.0.403' - run: dotnet tool restore - run: mkdir -p ./artifacts - run: >- @@ -44,7 +49,46 @@ jobs: --max-cyclomatic-complexity 10 ``` -Pin third-party actions to reviewed immutable commit SHAs in the real workflow. Add an artifact upload step when the report must be retained or sent to a compatible SARIF consumer. +The workflow uses reviewed immutable commit pins for `actions/checkout` and +`actions/setup-dotnet`. Update these pins deliberately as dependencies evolve. +Add an artifact upload step when reports must be retained or sent to a SARIF +consumer. + +## Manual CLI or published Action? + +| Integration | Prefer when | Setup | +| --- | --- | --- | +| Manual CLI | You need local runs, custom orchestration, or explicit control over CLI steps. | Manage a .NET tool manifest, SDK setup, invocation, and report retention. | +| [GitHub Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) | You want reusable GitHub CI analysis, quality gates, reports, and PR regression checks. | Use the published Action with a project or solution path; it installs the pinned CLI. | + +For a minimal Action-based workflow, use: + +```yaml +name: Complexity Action +on: + pull_request: + +permissions: + contents: read + +jobs: + analyze: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 + with: + persist-credentials: false + - name: Analyze complexity + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 + with: + path: App.slnx +``` + +Replace `App.slnx` with your project's actual path. The Action is pinned to +the reviewed `v1.0.0` commit; `@v1.0.0` is also available, but the moving +`@v1` alias has not yet been created. The Action defaults to CLI version +`1.0.1`, independently of its own `v1.0.0` version. Marketplace listing +visibility must be verified separately from GitHub Release publication. ## Gate semantics diff --git a/website/src/content/docs/pt-br/cli/github-actions.md b/website/src/content/docs/pt-br/cli/github-actions.md index feca06b..a5847e6 100644 --- a/website/src/content/docs/pt-br/cli/github-actions.md +++ b/website/src/content/docs/pt-br/cli/github-actions.md @@ -5,13 +5,18 @@ sidebar: order: 2 --- -Esta página demonstra o uso **manual da CLI**. Para integrar relatórios e regressões em PRs por meio de uma Action reutilizável, consulte a [Complexity Analysis GitHub Action](/complexity-analyzers/pt-br/action/). A primeira release estável está planejada, mas ainda não foi publicada. +Esta página demonstra o uso **manual da CLI**. Para verificações reutilizáveis +no CI do GitHub, a [Complexity Analysis Action](/complexity-analyzers/pt-br/action/) +já possui a [release `v1.0.0` publicada](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). +Ela invoca a mesma CLI, mas tem versionamento independente. Para começar, consulte +as [instruções de instalação](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) e os +[exemplos da versão](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). Use um manifesto local de ferramentas para que o workflow restaure uma versão revisada. ```bash dotnet new tool-manifest -dotnet tool install ComplexityAnalysis.Tool --version 1.0.0 +dotnet tool install ComplexityAnalysis.Tool --version 1.0.1 ``` Versione `.config/dotnet-tools.json` e invoque a ferramenta na CI: @@ -29,12 +34,12 @@ jobs: analyze: runs-on: ubuntu-latest steps: - - uses: actions/checkout@ + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with: persist-credentials: false - - uses: actions/setup-dotnet@ + - uses: actions/setup-dotnet@a98b56852c35b8e3190ac28c8c2271da59106c68 with: - dotnet-version: '10.0.x' + dotnet-version: '10.0.403' - run: dotnet tool restore - run: mkdir -p ./artifacts - run: >- @@ -44,7 +49,46 @@ jobs: --max-cyclomatic-complexity 10 ``` -No workflow real, fixe ações de terceiros em SHAs imutáveis revisados. Adicione upload de artefato quando o relatório precisar ser retido ou enviado a um consumidor SARIF compatível. +O workflow utiliza commits revisados para fixar `actions/checkout` e +`actions/setup-dotnet`. Atualize essas referências de forma controlada quando +as dependências evoluírem. Adicione upload de artefatos se os relatórios precisarem +ser retidos ou enviados a um consumidor SARIF. + +## CLI manual ou Action publicada? + +| Integração | Quando usar | Configuração | +| --- | --- | --- | +| CLI manual | Execução local, orquestração própria ou controle explícito dos comandos. | Gerencie manifesto .NET, SDK, comandos e armazenamento dos relatórios. | +| [GitHub Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) | Análise reutilizável no CI do GitHub, quality gates, relatórios e regressões em PRs. | Referencie a Action publicada com o caminho do projeto ou solução; ela instala a CLI fixada. | + +Para utilizar a Action diretamente: + +```yaml +name: Complexity Action +on: + pull_request: + +permissions: + contents: read + +jobs: + analyze: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 + with: + persist-credentials: false + - name: Analyze complexity + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 + with: + path: App.slnx +``` + +Substitua `App.slnx` pelo caminho do projeto ou solução. A Action está fixada no +commit revisado da `v1.0.0`. A tag `@v1.0.0` também está disponível, mas a +referência móvel `@v1` ainda não foi criada. A versão padrão da CLI instalada +pela Action é `1.0.1`, independente da versão `v1.0.0` da própria Action. +A disponibilidade no Marketplace exige verificação independente da GitHub Release. ## Semântica dos gates From 08c4e6fabf909e393269088fd9491abecbe1b9d5 Mon Sep 17 00:00:00 2001 From: Rodrigo de Oliveira Date: Sat, 31 Oct 2026 11:52:52 -0300 Subject: [PATCH 3/7] docs: update product selection guidance for published Action v1.0.0 --- .../docs/getting-started/choose-product.md | 25 ++++++++++++------ .../pt-br/getting-started/choose-product.md | 26 +++++++++++++------ 2 files changed, 35 insertions(+), 16 deletions(-) diff --git a/website/src/content/docs/getting-started/choose-product.md b/website/src/content/docs/getting-started/choose-product.md index f3d88c5..4e1b288 100644 --- a/website/src/content/docs/getting-started/choose-product.md +++ b/website/src/content/docs/getting-started/choose-product.md @@ -13,17 +13,26 @@ sidebar: ## Choose the CLI when -- you need whole-project or solution reports; -- CI must consume JSON or SARIF; -- snapshots, regression comparison, duplicate detection, or opt-in quality gates are required. +- you need whole-project or solution reports from local scripts, terminals, or custom CI; +- you want to manage CLI installation, snapshot comparison, and artifact handling yourself; +- you need JSON/SARIF output, duplicate detection, regression analysis, or opt-in quality gates outside a reusable GitHub Action. ## Choose the GitHub Action when -- your repository runs on GitHub Actions and needs reusable CI checks; -- you want configured quality gates, SARIF, and PR regression comparisons without maintaining custom scripts; -- you can use the currently supported Ubuntu runner and follow the Action's pre-release SHA guidance. +- your repository uses GitHub Actions and needs reusable checks on supported Ubuntu runners; +- you want opt-in quality gates, JSON/SARIF reports, and pull-request regression comparison without maintaining CLI setup scripts; +- you prefer the Action to install a fixed, published CLI version and integrate results into GitHub workflow summaries. -[Explore the Action](/complexity-analyzers/action/). The first stable `v1.0.0` is planned, not yet published. +The separately versioned [Complexity Analysis Action `v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) +was published on October 30, 2026. It uses `ComplexityAnalysis.Tool` `1.0.1` by default; +the Analyzer, CLI, MCP, and Action retain independent version numbers. + +For reproducibility, use the verified release commit in your workflow: +`rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67`. +The published `@v1.0.0` tag is also available; the moving `@v1` alias +has **not** been created yet. See the [Action guide](/complexity-analyzers/action/) +and [published workflow examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). GitHub Release publication +does not by itself confirm Marketplace listing visibility. ## Choose MCP when @@ -33,4 +42,4 @@ sidebar: ## Combine them deliberately -A common adoption path uses the Analyzer for immediate feedback, the CLI for local reports, the GitHub Action for reusable CI checks, and MCP for investigation. The Action invokes the CLI rather than reimplementing analysis. Keep all version pins and permissions explicit. +A common adoption path uses the Analyzer for immediate feedback, the CLI for local reports, the GitHub Action for reusable CI checks, and MCP for investigation. The Action invokes the published CLI rather than reimplementing analysis. Keep each product's version pin and workflow permissions explicit. diff --git a/website/src/content/docs/pt-br/getting-started/choose-product.md b/website/src/content/docs/pt-br/getting-started/choose-product.md index 3c360ad..ce8795a 100644 --- a/website/src/content/docs/pt-br/getting-started/choose-product.md +++ b/website/src/content/docs/pt-br/getting-started/choose-product.md @@ -13,17 +13,27 @@ sidebar: ## Escolha a CLI quando -- você precisa de relatórios do projeto ou solução; -- a CI deve consumir JSON ou SARIF; -- snapshots, comparação de regressões, duplicação ou quality gates opt-in são necessários. +- você precisa de relatórios de projetos ou soluções em scripts locais, terminais ou pipelines personalizados; +- deseja controlar a instalação da CLI, a comparação de snapshots e o armazenamento dos artefatos; +- precisa de JSON/SARIF, detecção de duplicação, análise de regressões ou quality gates opcionais fora de uma Action reutilizável. ## Escolha a GitHub Action quando -- seu repositório usa GitHub Actions e precisa de verificações reutilizáveis no CI; -- você quer quality gates, SARIF e comparação de regressões em PRs sem manter scripts próprios; -- é possível usar runners Ubuntu e seguir a orientação de SHA completo durante a fase pré-release. +- seu repositório usa GitHub Actions e precisa de verificações reutilizáveis em runners Ubuntu suportados; +- você quer quality gates opcionais, relatórios JSON/SARIF e comparação de regressões em PRs sem manter scripts de instalação da CLI; +- prefere que a Action instale uma versão publicada e fixa da CLI e apresente os resultados no resumo do workflow. -[Conheça a Action](/complexity-analyzers/pt-br/action/). A primeira `v1.0.0` está planejada e ainda não publicada. +A [Complexity Analysis Action `v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0), +com versionamento independente, foi publicada em 30 de outubro de 2026. +Por padrão, utiliza `ComplexityAnalysis.Tool` `1.0.1`; Analyzer, CLI, MCP e +Action mantêm versões independentes. + +Para maior reprodutibilidade, use o commit revisado da release no workflow: +`rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67`. +A tag publicada `@v1.0.0` também está disponível; a referência móvel `@v1` +**ainda não foi criada**. Consulte o [guia da Action](/complexity-analyzers/pt-br/action/) +e os [exemplos publicados](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). Publicar a GitHub Release não +comprova, por si só, a disponibilidade da listagem no Marketplace. ## Escolha o MCP quando @@ -33,4 +43,4 @@ sidebar: ## Combine de forma deliberada -Um caminho comum usa Analyzer para feedback imediato, CLI para relatórios locais, GitHub Action para checks reutilizáveis no CI e MCP para investigação. A Action invoca a CLI e não reimplementa o motor. Mantenha versões e permissões explícitas. +Um caminho comum usa Analyzer para feedback imediato, CLI para relatórios locais, GitHub Action para checks reutilizáveis no CI e MCP para investigação. A Action invoca a CLI publicada e não reimplementa o motor de análise. Mantenha explícitos os versionamentos de cada produto e as permissões dos workflows. From 05454f834ab70bf42a3cb4c65fc83cca75fb0224 Mon Sep 17 00:00:00 2001 From: Rodrigo de Oliveira Date: Sat, 31 Oct 2026 13:44:18 -0300 Subject: [PATCH 4/7] docs: update bilingual Action reference to published v1.0.0 --- docs/en/github-action.md | 45 +++++++++++++++++++++++++++--------- docs/pt-BR/github-action.md | 46 ++++++++++++++++++++++++++++--------- 2 files changed, 69 insertions(+), 22 deletions(-) diff --git a/docs/en/github-action.md b/docs/en/github-action.md index f7feeed..820345b 100644 --- a/docs/en/github-action.md +++ b/docs/en/github-action.md @@ -4,7 +4,12 @@ `Complexity Analysis Action` makes the existing [ComplexityAnalysis.Tool](project-tooling.md) available in GitHub Actions workflows. It **does not** implement a second analyzer. Use the Roslyn package for diagnostics in your IDE/build, the CLI for local or custom automation, the MCP server for AI-tool integrations, and the GitHub Action when you want reusable CI checks and pull-request feedback. -The Action lives in a **separate repository** and has its own release cycle. The planned first stable Action release is `v1.0.0`; **as of this documentation update it has not been published**, so `@v1` and `@v1.0.0` must not be treated as existing tags. Review the [Action repository](https://github.com/rodri-oliveira-dev/complexity-analysis-action) for current status before adopting it. +The Action lives in a **separate repository** and has its own release cycle. +Its first stable version, [`v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0), +was published on October 30, 2026. The `@v1.0.0` version tag exists and +points to the reviewed commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`. The moving +`@v1` major-version alias has **not** been created yet. GitHub Release +publication does not by itself confirm a public Marketplace listing. ## What it offers @@ -18,13 +23,21 @@ A complexity estimate is **not** a runtime benchmark or proof of actual latency. ## Requirements and versioning -The current release candidate supports Ubuntu runners with Bash, Python 3, and access to NuGet.org. It installs the .NET 10 SDK and the **exact** published `ComplexityAnalysis.Tool` version specified by `tool-version` (currently `1.0.1` by default). The CLI, Action, Analyzer, and MCP packages have **independent versions**. +The published `v1.0.0` supports Ubuntu runners with Bash, Python 3, and +access to NuGet.org. It installs .NET SDK `10.0.403` and uses the exact +published `ComplexityAnalysis.Tool` version supplied by `tool-version` +(`1.0.1` by default). Windows and macOS have not been validated as supported +runners. The CLI, Action, Analyzer, and MCP have **independent versions**. -Before the first stable release, use a **reviewed full 40-character commit SHA** from the Action repository in `uses:`. The placeholder below is intentionally not executable. When a stable version is published, a specific release tag such as `@v1.0.0` or a full SHA may be used; `@v1` is only available when the maintainers create that major-version reference. +For reproducible consumption, prefer the full 40-character reviewed release +commit SHA in `uses:`; the published `@v1.0.0` tag is also available. +Do not use `@v1` until its compatibility reference is created and verified. +The public release-tag ruleset and GitHub Release immutability are separate +controls; do not assume the latter is enabled. ## Example: analyze a pull request -Save the following as `.github/workflows/complexity.yml` in the **consumer** repository, after replacing `REVIEWED_FULL_40_CHARACTER_SHA` and `MySolution.slnx`: +Save the following as `.github/workflows/complexity.yml` in the **consumer** repository. It is pinned to the published Action release commit; replace only `MySolution.slnx` with the path to your `.csproj`, `.sln`, or `.slnx`: ```yaml name: Complexity analysis @@ -39,11 +52,11 @@ jobs: analyze: runs-on: ubuntu-latest steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with: persist-credentials: false - id: complexity - uses: rodri-oliveira-dev/complexity-analysis-action@REVIEWED_FULL_40_CHARACTER_SHA + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 with: path: MySolution.slnx max-cyclomatic-complexity: "15" @@ -53,7 +66,17 @@ jobs: fail-on-regression: "true" ``` -This example is **read-only**; it does not post comments, upload SARIF, or expose a write-capable token. The Action reports comparison problems separately from confirmed regressions. To retain report files after the job, add an `actions/upload-artifact` step using the Action's output paths. +This example uses **read-only** permissions: it does not post comments, upload +SARIF to Code Scanning, or expose a write-capable token. The Action reports +unavailable comparisons separately from confirmed regressions; a missing +baseline is not proof of no regressions. To retain reports after the job, +add a SHA-pinned `actions/upload-artifact` step using the Action's output paths. + +For additional runnable workflows, use the +[updated examples on the Action's `main` branch](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). +The `v1.0.0` tag preserves its original release snapshot, including +documentation examples that still contain pre-publication placeholders; +the corrected, executable examples were committed to `main` after the release. ## Inputs and outputs @@ -90,15 +113,15 @@ The Action exposes `report-path`, `sarif-path`, `analysis-status`, `quality-gate | Optional direct PR comment in a trusted same-repository workflow | `contents: read`, `pull-requests: write` | | Fork PR feedback | Read-only analysis plus a separate privileged `workflow_run` publisher | -Never analyze untrusted pull-request code under `pull_request_target`, and never give write-capable credentials or secrets to a job loading untrusted projects. MSBuild project evaluation may execute project-controlled logic; the Action is **not** a sandbox. For fork PRs, keep analysis read-only and use the Action's [isolated publisher example](https://github.com/rodri-oliveira-dev/complexity-analysis-action/blob/feature/release-readiness/examples/secure-pr-publish.yml) if comments are required. Avoid copying that privileged workflow without reviewing the artifact-provenance restrictions. +Never analyze untrusted pull-request code under `pull_request_target`, and never give write-capable credentials or secrets to a job loading untrusted projects. MSBuild project evaluation may execute project-controlled logic; the Action is **not** a sandbox. For fork PRs, keep analysis read-only and use the Action's [isolated publisher example](https://github.com/rodri-oliveira-dev/complexity-analysis-action/blob/main/examples/secure-pr-publish.yml) if comments are required. Avoid copying that privileged workflow without reviewing the artifact-provenance restrictions. ## Troubleshooting -- **Action not found at `@v1` or `@v1.0.0`:** the initial release and tag alias may not exist. Check [releases](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases) and pin a reviewed commit SHA during evaluation. -- **Unsupported runner:** the current release candidate documents Ubuntu only; Windows/macOS have not passed equivalent end-to-end validation. +- **Action not found at `@v1`:** that moving alias has not yet been created. Use the published `@v1.0.0` tag or approved release commit SHA above. If `@v1.0.0` fails, confirm the repository reference and the [published release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). +- **Unsupported runner:** `v1.0.0` supports Ubuntu only; Windows/macOS have not passed equivalent end-to-end validation. - **Missing project or unexpected comparison failure:** confirm the path exists and the entry point can be resolved at both base and head revisions. A missing baseline is **not** “no regressions.” - **NuGet/tool installation error:** check network access, the .NET 10 requirement, and that `tool-version` is an exact published version. - **SARIF upload or comment denied:** review token permissions, Code Scanning availability, fork restrictions, and the security split between analysis and publishing. - **Configured gates fail:** a quality-gate failure is separate from a proven regression; inspect `quality-gate-status`, `comparison-status`, and the JSON reports. -For complete workflow examples, visit the [Action repository](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/feature/release-readiness/examples). For standalone CLI commands, use [Project-Level Tooling](project-tooling.md). +For complete workflow examples, visit the [Action repository](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). For standalone CLI commands, use [Project-Level Tooling](project-tooling.md). diff --git a/docs/pt-BR/github-action.md b/docs/pt-BR/github-action.md index e4bdace..1be0ef4 100644 --- a/docs/pt-BR/github-action.md +++ b/docs/pt-BR/github-action.md @@ -4,7 +4,12 @@ A `Complexity Analysis Action` disponibiliza a [ComplexityAnalysis.Tool](project-tooling.md) em workflows do GitHub Actions. Ela **não** implementa outro motor de análise. Use o pacote Roslyn para diagnósticos na IDE/compilação, a CLI para execução local ou automações próprias, o MCP para ferramentas de IA e a GitHub Action para verificações reutilizáveis em CI e feedback nos pull requests. -A Action fica em um **repositório separado** e possui ciclo de releases independente. A primeira versão estável planejada é `v1.0.0`; **na data desta atualização ela ainda não foi publicada**, portanto `@v1` e `@v1.0.0` não devem ser tratados como tags existentes. Consulte o [repositório da Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action) para confirmar o estado atual. +A Action fica em um **repositório separado**, com ciclo de releases independente. +Sua primeira versão estável, [`v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0), +foi publicada em 30 de outubro de 2026. A tag `@v1.0.0` existe e aponta +para o commit revisado `2d807ef29ca03c685d224543a135d8c30dfe2c67`. A referência móvel +`@v1` **ainda não foi criada**. Publicar a GitHub Release não comprova, +por si só, que a Action já aparece publicamente no Marketplace. ## O que ela oferece @@ -18,13 +23,21 @@ Uma estimativa de complexidade **não** equivale a benchmark de desempenho nem c ## Requisitos e versionamento -A candidata atual suporta Ubuntu com Bash, Python 3 e acesso ao NuGet.org. Ela instala o SDK .NET 10 e a versão **exata** da `ComplexityAnalysis.Tool` configurada em `tool-version` (atualmente `1.0.1` por padrão). CLI, Action, Analyzer e MCP possuem **versões independentes**. +A versão publicada `v1.0.0` suporta runners Ubuntu com Bash, Python 3 e +acesso ao NuGet.org. Ela instala o SDK .NET `10.0.403` e usa a versão exata, +publicada, da `ComplexityAnalysis.Tool` definida em `tool-version` +(`1.0.1` por padrão). Windows e macOS ainda não possuem suporte validado. +CLI, Action, Analyzer e MCP têm **versões independentes**. -Até a primeira release estável, utilize no `uses:` um **SHA completo de 40 caracteres, revisado**, do repositório da Action. O marcador do exemplo abaixo não é executável sem substituição. Após a publicação, será possível utilizar uma tag específica, como `@v1.0.0`, ou o SHA completo. `@v1` só ficará disponível quando a referência da versão principal for criada. +Para maior reprodutibilidade, prefira o SHA completo de 40 caracteres do commit +revisado da release em `uses:`. A tag publicada `@v1.0.0` também pode ser usada. +Não utilize `@v1` até que a referência compatível exista e seja verificada. +A proteção das tags de release é diferente da imutabilidade de GitHub Releases; +não presuma que esta última esteja habilitada. ## Exemplo: analisar um pull request -Crie `.github/workflows/complexity.yml` no repositório **consumidor**, substituindo `REVIEWED_FULL_40_CHARACTER_SHA` e `MySolution.slnx`: +Crie `.github/workflows/complexity.yml` no repositório **consumidor**. O exemplo usa o commit da Action publicado na release; substitua apenas `MySolution.slnx` pelo caminho do arquivo `.csproj`, `.sln` ou `.slnx`: ```yaml name: Complexity analysis @@ -39,11 +52,11 @@ jobs: analyze: runs-on: ubuntu-latest steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with: persist-credentials: false - id: complexity - uses: rodri-oliveira-dev/complexity-analysis-action@REVIEWED_FULL_40_CHARACTER_SHA + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 with: path: MySolution.slnx max-cyclomatic-complexity: "15" @@ -53,7 +66,18 @@ jobs: fail-on-regression: "true" ``` -Esse exemplo funciona com **permissões de leitura**: não publica comentários, não envia SARIF e não expõe um token de escrita. Falhas de comparação são apresentadas separadamente das regressões comprovadas. Para guardar os relatórios após o job, acrescente um passo `actions/upload-artifact` utilizando os caminhos retornados pela Action. +Este exemplo usa **permissões somente de leitura**: não publica comentários, +não envia SARIF ao Code Scanning e não expõe credenciais de escrita. Comparações +indisponíveis são reportadas separadamente das regressões comprovadas; baseline +ausente não significa ausência de regressões. Para preservar os relatórios após +o job, adicione `actions/upload-artifact` fixado em um SHA revisado e utilize os +caminhos retornados pela Action. + +Para outros workflows executáveis, consulte os +[exemplos atualizados na branch `main` da Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). +A tag `v1.0.0` preserva a documentação da release original, inclusive +exemplos com marcadores anteriores à publicação. Os exemplos corrigidos +foram adicionados à `main` após o lançamento. ## Entradas e saídas @@ -90,15 +114,15 @@ As saídas incluem `report-path`, `sarif-path`, `analysis-status`, `quality-gate | Comentário direto em PR confiável do mesmo repositório | `contents: read`, `pull-requests: write` | | Comentário em PR de fork | Análise somente leitura e publicação privilegiada separada via `workflow_run` | -Nunca analise código de PR não confiável usando `pull_request_target`, nem exponha segredos ou credenciais de escrita ao job que carrega projetos externos. A avaliação de projetos MSBuild pode executar lógica definida no repositório; a Action **não é um sandbox**. Para PRs de forks, mantenha a análise somente leitura e avalie o [exemplo de publicador isolado](https://github.com/rodri-oliveira-dev/complexity-analysis-action/blob/feature/release-readiness/examples/secure-pr-publish.yml) antes de copiar o workflow. A validação da procedência do artefato é obrigatória. +Nunca analise código de PR não confiável usando `pull_request_target`, nem exponha segredos ou credenciais de escrita ao job que carrega projetos externos. A avaliação de projetos MSBuild pode executar lógica definida no repositório; a Action **não é um sandbox**. Para PRs de forks, mantenha a análise somente leitura e avalie o [exemplo de publicador isolado](https://github.com/rodri-oliveira-dev/complexity-analysis-action/blob/main/examples/secure-pr-publish.yml) antes de copiar o workflow. A validação da procedência do artefato é obrigatória. ## Solução de problemas -- **Action não encontrada em `@v1` ou `@v1.0.0`:** a release e as tags podem não existir. Confira as [releases](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases) e, na avaliação, use um SHA completo revisado. -- **Runner não suportado:** a candidata documenta apenas Ubuntu; não há validação end-to-end equivalente para Windows/macOS. +- **Action não encontrada com `@v1`:** essa referência móvel ainda não foi criada. Use a tag publicada `@v1.0.0` ou o SHA aprovado acima. Se `@v1.0.0` falhar, confirme a referência do repositório e a [release publicada](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). +- **Runner não suportado:** a `v1.0.0` suporta apenas Ubuntu; não há validação end-to-end equivalente para Windows/macOS. - **Projeto ausente ou comparação indisponível:** confira o caminho e se o projeto existe nas revisões-base e atual. Baseline ausente **não** significa ausência de regressões. - **Falha de instalação do NuGet:** confira o acesso à rede, o requisito de .NET 10 e a versão publicada exata de `tool-version`. - **Upload SARIF ou comentário negado:** confira permissões, disponibilidade do Code Scanning, restrições de forks e isolamento entre análise e publicação. - **Quality gate falhou:** violar um limite absoluto é diferente de introduzir uma regressão. Consulte `quality-gate-status`, `comparison-status` e os relatórios JSON. -Os exemplos completos estão no [repositório da Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/feature/release-readiness/examples). Para executar a CLI diretamente, consulte [Ferramentas em Nível de Projeto](project-tooling.md). +Os exemplos completos estão no [repositório da Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). Para executar a CLI diretamente, consulte [Ferramentas em Nível de Projeto](project-tooling.md). From b571d01f46eaedcf79f909d49f810cedf5f0d09c Mon Sep 17 00:00:00 2001 From: Rodrigo de Oliveira Date: Sat, 31 Oct 2026 14:56:55 -0300 Subject: [PATCH 5/7] docs: update Action landing pages for published v1.0.0 --- website/src/content/docs/action/index.md | 20 +++++++++++-------- .../src/content/docs/pt-br/action/index.md | 20 +++++++++++-------- 2 files changed, 24 insertions(+), 16 deletions(-) diff --git a/website/src/content/docs/action/index.md b/website/src/content/docs/action/index.md index acbd4b6..7442196 100644 --- a/website/src/content/docs/action/index.md +++ b/website/src/content/docs/action/index.md @@ -9,8 +9,10 @@ The **Complexity Analysis Action** brings the published [project-level CLI](/com The Action lives in a [separate repository](https://github.com/rodri-oliveira-dev/complexity-analysis-action) and uses the same analysis engine as the CLI, Roslyn Analyzer, and MCP server. It does **not** implement a second complexity model. -:::caution[Release status] -The first stable Action release, `v1.0.0`, is **planned but not yet published** at the time of this update. Do not use `@v1` or `@v1.0.0` until those tags exist. The GitHub Marketplace listing is not yet available. For evaluation, pin a **reviewed full commit SHA** from the [Action repository](https://github.com/rodri-oliveira-dev/complexity-analysis-action) and check its current status. +:::note[Stable release available] +[Complexity Analysis Action `v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) was published on October 30, 2026. Use the reviewed release commit SHA `2d807ef29ca03c685d224543a135d8c30dfe2c67` for reproducible workflows, or the published `@v1.0.0` tag. The moving `@v1` alias has **not** been created yet. + +The public GitHub Marketplace listing has not been independently verified. A GitHub Release does not itself confirm Marketplace visibility. ::: ## When to choose the Action @@ -35,7 +37,7 @@ Unknown or incomparable evidence is not automatically treated as a regression, a ## Example: read-only PR analysis -Create `.github/workflows/complexity.yml` in your C# repository. Replace the placeholder with a **real reviewed 40-character commit SHA**, and the solution name with your own path: +Create `.github/workflows/complexity.yml` in your C# repository. The workflow pins the published release commit; replace `MySolution.slnx` with your `.csproj`, `.sln`, or `.slnx` path: ```yaml name: Complexity review @@ -49,11 +51,11 @@ jobs: complexity: runs-on: ubuntu-latest steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with: persist-credentials: false - id: analysis - uses: rodri-oliveira-dev/complexity-analysis-action@REVIEWED_FULL_40_CHARACTER_SHA + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 with: path: MySolution.slnx max-cyclomatic-complexity: '15' @@ -62,11 +64,13 @@ jobs: fail-on-regression: 'true' ``` -This is an **illustrative template, not directly executable** while the SHA remains a placeholder. The sample intentionally uses read-only permissions and does not post comments. To retain reports, add an artifact-upload step after analysis using the documented output paths. +The Action reference is executable as shown once you supply an existing project or solution path. The sample keeps permissions **read-only** and does not post comments or upload SARIF to Code Scanning. If the baseline is unavailable, the comparison is not equivalent to a successful "no regressions" result. To retain reports, add a SHA-pinned `actions/upload-artifact` step using the [documented outputs](/complexity-analyzers/action/reference/). + +For additional configurations, see the [maintained workflow examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). The release tag `v1.0.0` preserves the original snapshot, whose example files contain pre-publication SHA placeholders; the examples on the Action's `main` branch have been corrected. ## Requirements and security -The current release candidate supports **Ubuntu runners**, requires access to NuGet.org, and installs .NET SDK 10. Its default published CLI dependency is `ComplexityAnalysis.Tool` `1.0.1`. Windows and macOS support are not claimed without equivalent end-to-end evidence. +The published `v1.0.0` supports **Ubuntu runners**, requires Bash, Python 3, and access to NuGet.org, and installs .NET SDK `10.0.403`. Its default exact CLI dependency is `ComplexityAnalysis.Tool` `1.0.1`. Windows and macOS support are not claimed without equivalent end-to-end evidence. Simple analysis and comparisons need only `contents: read`. SARIF upload additionally requires `security-events: write`. Direct comments require `pull-requests: write`, which should **not** be exposed to untrusted PR analysis. For fork contributions, use isolated read-only analysis and a separate trusted publishing workflow. @@ -76,4 +80,4 @@ Loading MSBuild projects can execute project-controlled logic. The Action is not For every supported input, output, comparison status, and troubleshooting scenario, see the [full Action reference](/complexity-analyzers/action/reference/). For a workflow that installs the CLI manually instead, see the [CLI GitHub Actions guide](/complexity-analyzers/cli/github-actions/). -Source and detailed examples: [Complexity Analysis Action repository](https://github.com/rodri-oliveira-dev/complexity-analysis-action). +Start from the [published `v1.0.0` release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0), explore the [up-to-date workflow examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples), or consult the [Complexity Analysis Action repository](https://github.com/rodri-oliveira-dev/complexity-analysis-action). diff --git a/website/src/content/docs/pt-br/action/index.md b/website/src/content/docs/pt-br/action/index.md index 60d89c2..4ed87b1 100644 --- a/website/src/content/docs/pt-br/action/index.md +++ b/website/src/content/docs/pt-br/action/index.md @@ -9,8 +9,10 @@ A **Complexity Analysis Action** disponibiliza a [CLI de projetos](/complexity-a A Action está em um [repositório separado](https://github.com/rodri-oliveira-dev/complexity-analysis-action) e reutiliza o mesmo motor de análise da CLI, do Roslyn Analyzer e do MCP. Ela **não** implementa outro modelo de complexidade. -:::caution[Estado da publicação] -A primeira release estável da Action, `v1.0.0`, está **planejada, mas ainda não publicada** nesta atualização. Não utilize `@v1` ou `@v1.0.0` enquanto as tags não existirem. A listagem no GitHub Marketplace ainda não está disponível. Para avaliações, fixe um **SHA completo de commit revisado** do [repositório da Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action) e confira o estado atual. +:::note[Versão estável disponível] +A [Complexity Analysis Action `v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) foi publicada em 30 de outubro de 2026. Para reproduzir o mesmo comportamento, utilize o SHA aprovado `2d807ef29ca03c685d224543a135d8c30dfe2c67` ou a tag publicada `@v1.0.0`. A referência móvel `@v1` **ainda não foi criada**. + +A listagem pública no GitHub Marketplace não foi verificada de forma independente. Publicar uma GitHub Release não comprova, por si só, a presença no Marketplace. ::: ## Quando escolher a Action @@ -35,7 +37,7 @@ Evidências desconhecidas ou incomparáveis não são tratadas automaticamente c ## Exemplo: análise de PR somente leitura -Crie `.github/workflows/complexity.yml` no seu repositório C#. Substitua o marcador por um **SHA completo de 40 caracteres de um commit revisado** e o nome da solução pelo caminho real: +Crie `.github/workflows/complexity.yml` no seu repositório C#. O workflow já utiliza o SHA da versão publicada; substitua `MySolution.slnx` pelo caminho real do arquivo `.csproj`, `.sln` ou `.slnx`: ```yaml name: Complexity review @@ -49,11 +51,11 @@ jobs: complexity: runs-on: ubuntu-latest steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with: persist-credentials: false - id: analysis - uses: rodri-oliveira-dev/complexity-analysis-action@REVIEWED_FULL_40_CHARACTER_SHA + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 with: path: MySolution.slnx max-cyclomatic-complexity: '15' @@ -62,11 +64,13 @@ jobs: fail-on-regression: 'true' ``` -Este é um **modelo ilustrativo**, não executável diretamente enquanto o SHA for um marcador. O exemplo usa apenas permissões de leitura e não publica comentários. Para guardar os relatórios, adicione o upload de artefatos usando os caminhos disponibilizados pela Action. +A referência da Action já é executável; é necessário apenas informar um caminho existente para o projeto ou solução. O exemplo usa **permissões somente de leitura**, sem publicar comentários ou enviar SARIF ao Code Scanning. Se o baseline estiver indisponível, isso não equivale a uma análise concluída sem regressões. Para preservar os relatórios, utilize `actions/upload-artifact` fixado em um SHA revisado e os [outputs documentados](/complexity-analyzers/pt-br/action/reference/). + +Consulte também os [workflows mantidos na branch principal](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). A tag `v1.0.0` preserva o snapshot original, cujos exemplos ainda contêm SHAs provisórios; os arquivos na `main` da Action já foram corrigidos. ## Requisitos e segurança -A candidata atual suporta **runners Ubuntu**, exige acesso ao NuGet.org e instala o SDK .NET 10. A dependência CLI padrão é a versão publicada `1.0.1` de `ComplexityAnalysis.Tool`. Não há suporte anunciado para Windows ou macOS sem validação end-to-end equivalente. +A `v1.0.0` publicada suporta **runners Ubuntu**, exige Bash, Python 3 e acesso ao NuGet.org e instala o SDK .NET `10.0.403`. Sua dependência CLI padrão é a versão exata publicada `1.0.1` de `ComplexityAnalysis.Tool`. Não há suporte anunciado para Windows ou macOS sem validação end-to-end equivalente. Análises e comparações simples exigem somente `contents: read`. O upload de SARIF exige também `security-events: write`. Comentários diretos exigem `pull-requests: write`, que **não** deve ser exposto a jobs que analisam PRs não confiáveis. Para contribuições de forks, utilize análise isolada e somente leitura, com um workflow de publicação confiável separado. @@ -76,4 +80,4 @@ O carregamento de projetos MSBuild pode executar lógica controlada pelo reposit A [referência completa da Action](/complexity-analyzers/pt-br/action/reference/) descreve os inputs, outputs, estados de comparação e soluções de problemas. Para instalar e executar a CLI manualmente em um workflow, consulte o [guia GitHub Actions da CLI](/complexity-analyzers/pt-br/cli/github-actions/). -Código-fonte e exemplos: [repositório Complexity Analysis Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action). +Comece pela [release publicada `v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0), consulte os [exemplos de workflow atualizados](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples) ou acesse o [repositório Complexity Analysis Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action). From b3736b371d678393bccdef720418855c10bf225d Mon Sep 17 00:00:00 2001 From: Rodrigo de Oliveira Date: Sat, 31 Oct 2026 16:33:53 -0300 Subject: [PATCH 6/7] docs: publish bilingual quick-install guidance for Action v1.0.0 --- .../docs/getting-started/quick-install.md | 46 ++++++++++++++++-- .../pt-br/getting-started/quick-install.md | 47 +++++++++++++++++-- 2 files changed, 87 insertions(+), 6 deletions(-) diff --git a/website/src/content/docs/getting-started/quick-install.md b/website/src/content/docs/getting-started/quick-install.md index 826a2e3..2a8f3c3 100644 --- a/website/src/content/docs/getting-started/quick-install.md +++ b/website/src/content/docs/getting-started/quick-install.md @@ -17,10 +17,10 @@ Roslyn loads the analyzer during builds and IDE analysis. Your application does ## CLI -The documented `1.0.0` command applies after that version is published on NuGet.org: +The published `ComplexityAnalysis.Tool` version used by Action `v1.0.0` is `1.0.1`. Install the CLI directly for local scripts or custom CI orchestration: ```bash -dotnet tool install --global ComplexityAnalysis.Tool --version 1.0.0 +dotnet tool install --global ComplexityAnalysis.Tool --version 1.0.1 complexity-analysis --version ``` @@ -28,7 +28,47 @@ For reproducible repositories, prefer a local tool manifest and commit `.config/ ## GitHub Action -For GitHub CI, the separately maintained [Complexity Analysis Action](/complexity-analyzers/action/) runs the published CLI for you. The first stable `v1.0.0` and `v1` references are **not yet published**; evaluate with a reviewed full commit SHA after checking the Action repository, rather than copying a nonexistent release tag. +The separately maintained [Complexity Analysis Action](/complexity-analyzers/action/) +runs the published CLI for you in GitHub CI. Its +[stable `v1.0.0` release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) was +published on October 30, 2026. It supports Ubuntu runners, installs .NET SDK +`10.0.403`, and uses `ComplexityAnalysis.Tool` `1.0.1` by default. + +Create `.github/workflows/complexity.yml` in the repository to be analyzed: + +```yaml +name: Complexity Analysis +on: + pull_request: + +permissions: + contents: read + +jobs: + analyze: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 + with: + persist-credentials: false + - name: Analyze C# complexity + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 + with: + path: MySolution.slnx +``` + +Replace `MySolution.slnx` with the actual `.csproj`, `.sln`, or `.slnx` +path. The example pins the reviewed `v1.0.0` commit to a full SHA for +reproducibility. The published `@v1.0.0` tag is also available; the moving +`@v1` alias has **not** been created yet. Analysis uses read-only +`contents: read` permissions; optional Code Scanning uploads and PR comments +require additional permissions and the security guidance in the full reference. + +See the [Action reference](/complexity-analyzers/action/reference/) and +[maintained workflow examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). +Marketplace listing visibility has not been independently verified by the +GitHub Release publication. The Action, CLI, Analyzer, and MCP retain +independent release versions. ## MCP server diff --git a/website/src/content/docs/pt-br/getting-started/quick-install.md b/website/src/content/docs/pt-br/getting-started/quick-install.md index e08f0e4..a420fb2 100644 --- a/website/src/content/docs/pt-br/getting-started/quick-install.md +++ b/website/src/content/docs/pt-br/getting-started/quick-install.md @@ -17,10 +17,10 @@ O Roslyn carrega o analyzer durante builds e análise na IDE. A aplicação não ## CLI -O comando documentado para `1.0.0` se aplica depois que essa versão estiver publicada no NuGet.org: +A versão publicada de `ComplexityAnalysis.Tool` utilizada pela Action `v1.0.0` é `1.0.1`. Instale a CLI diretamente para scripts locais ou orquestração personalizada no CI: ```bash -dotnet tool install --global ComplexityAnalysis.Tool --version 1.0.0 +dotnet tool install --global ComplexityAnalysis.Tool --version 1.0.1 complexity-analysis --version ``` @@ -28,7 +28,48 @@ Para repositórios reproduzíveis, prefira um manifesto local e versione `.confi ## GitHub Action -No GitHub CI, a [Complexity Analysis Action](/complexity-analyzers/pt-br/action/) executa a CLI publicada por você. A primeira `v1.0.0` e a referência `v1` **ainda não foram publicadas**; durante a avaliação, use um SHA completo de commit revisado, não uma tag inexistente. +No GitHub CI, a [Complexity Analysis Action](/complexity-analyzers/pt-br/action/) +executa a CLI publicada sem exigir scripts próprios de instalação. Sua +[release estável `v1.0.0`](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) foi +publicada em 30 de outubro de 2026. Ela suporta runners Ubuntu, instala o SDK +.NET `10.0.403` e utiliza `ComplexityAnalysis.Tool` `1.0.1` por padrão. + +Crie `.github/workflows/complexity.yml` no repositório que deseja analisar: + +```yaml +name: Complexity Analysis +on: + pull_request: + +permissions: + contents: read + +jobs: + analyze: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 + with: + persist-credentials: false + - name: Analyze C# complexity + uses: rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67 + with: + path: MySolution.slnx +``` + +Substitua `MySolution.slnx` pelo caminho real do arquivo `.csproj`, `.sln` +ou `.slnx`. O exemplo fixa o commit revisado da `v1.0.0` em um SHA completo +para maior reprodutibilidade. A tag publicada `@v1.0.0` também está +disponível; a referência móvel `@v1` **ainda não foi criada**. A análise +utiliza apenas a permissão `contents: read`; uploads ao Code Scanning e +comentários em PRs exigem permissões adicionais e os cuidados descritos na +referência técnica. + +Consulte a [referência da Action](/complexity-analyzers/pt-br/action/reference/) +e os [exemplos de workflow mantidos](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). +A presença no Marketplace não foi verificada de maneira independente da +publicação da GitHub Release. Action, CLI, Analyzer e MCP mantêm ciclos +de releases independentes. ## Servidor MCP From a811f30d2313bd93329891d23045aa2d2b0eb558 Mon Sep 17 00:00:00 2001 From: Rodrigo de Oliveira Date: Sat, 31 Oct 2026 19:35:58 -0300 Subject: [PATCH 7/7] docs: address CodeRabbit review on example links and v1 alias --- README.md | 2 +- README.pt-BR.md | 2 +- docs/en/project-tooling.md | 2 +- docs/pt-BR/project-tooling.md | 2 +- website/src/content/docs/cli/github-actions.md | 2 +- website/src/content/docs/getting-started/choose-product.md | 2 +- website/src/content/docs/pt-br/cli/github-actions.md | 2 +- .../src/content/docs/pt-br/getting-started/choose-product.md | 2 +- website/src/content/docs/pt-br/reference/releases.md | 2 +- website/src/content/docs/reference/releases.md | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4bcbf9b..f31408f 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ jobs: path: MySolution.slnx ``` -The example pins the reviewed `v1.0.0` commit for reproducibility. The published tag `@v1.0.0` is also available, but the moving `@v1` alias has not been verified. See the [Action installation instructions](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) and [release notes](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). +The example pins the reviewed `v1.0.0` commit for reproducibility. The published tag `@v1.0.0` is also available, but the moving `@v1` alias has not been created; do not use it until that reference exists. See the [Action installation instructions](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) and [release notes](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). ## Quick example diff --git a/README.pt-BR.md b/README.pt-BR.md index 2a1135a..a3b07fa 100644 --- a/README.pt-BR.md +++ b/README.pt-BR.md @@ -68,7 +68,7 @@ jobs: path: MySolution.slnx ``` -O exemplo utiliza o SHA revisado da `v1.0.0` para maior reprodutibilidade. A tag publicada `@v1.0.0` também está disponível, mas a referência móvel `@v1` ainda não foi verificada. Consulte as [instruções de instalação](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) e as [notas da release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). +O exemplo utiliza o SHA revisado da `v1.0.0` para maior reprodutibilidade. A tag publicada `@v1.0.0` também está disponível, mas a referência móvel `@v1` ainda não foi criada; não a utilize até que esse alias exista. Consulte as [instruções de instalação](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) e as [notas da release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). ## Exemplo rápido diff --git a/docs/en/project-tooling.md b/docs/en/project-tooling.md index 589e7b9..e3b0333 100644 --- a/docs/en/project-tooling.md +++ b/docs/en/project-tooling.md @@ -322,5 +322,5 @@ For reproducibility, pin the Action to the reviewed `v1.0.0` release commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`; the published `@v1.0.0` tag is another supported option. The moving `@v1` alias has not been created yet. See the [GitHub Action guide](github-action.md) and -[published examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples) for +[published examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples) for supported inputs and security considerations. diff --git a/docs/pt-BR/project-tooling.md b/docs/pt-BR/project-tooling.md index 385e7af..5553249 100644 --- a/docs/pt-BR/project-tooling.md +++ b/docs/pt-BR/project-tooling.md @@ -326,5 +326,5 @@ Para maior reprodutibilidade, fixe a Action no commit revisado da `v1.0.0`, `2d807ef29ca03c685d224543a135d8c30dfe2c67`; a tag publicada `@v1.0.0` também está disponível. A referência móvel `@v1` ainda não foi criada. Consulte o [guia da GitHub Action](github-action.md) e os -[exemplos publicados](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples) para +[exemplos publicados](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples) para informações sobre inputs e segurança. diff --git a/website/src/content/docs/cli/github-actions.md b/website/src/content/docs/cli/github-actions.md index 235e5dc..fc9b9e8 100644 --- a/website/src/content/docs/cli/github-actions.md +++ b/website/src/content/docs/cli/github-actions.md @@ -10,7 +10,7 @@ the [Complexity Analysis Action](/complexity-analyzers/action/) is available in its [published `v1.0.0` release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). It invokes the same CLI, but its release versions are independent. For adoption, see the [installation guide](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) and the -[versioned examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). +[versioned examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). Use a repository-local tool manifest so the workflow restores a reviewed version. diff --git a/website/src/content/docs/getting-started/choose-product.md b/website/src/content/docs/getting-started/choose-product.md index 4e1b288..adf8477 100644 --- a/website/src/content/docs/getting-started/choose-product.md +++ b/website/src/content/docs/getting-started/choose-product.md @@ -31,7 +31,7 @@ For reproducibility, use the verified release commit in your workflow: `rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67`. The published `@v1.0.0` tag is also available; the moving `@v1` alias has **not** been created yet. See the [Action guide](/complexity-analyzers/action/) -and [published workflow examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). GitHub Release publication +and [published workflow examples](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). GitHub Release publication does not by itself confirm Marketplace listing visibility. ## Choose MCP when diff --git a/website/src/content/docs/pt-br/cli/github-actions.md b/website/src/content/docs/pt-br/cli/github-actions.md index a5847e6..9b908db 100644 --- a/website/src/content/docs/pt-br/cli/github-actions.md +++ b/website/src/content/docs/pt-br/cli/github-actions.md @@ -10,7 +10,7 @@ no CI do GitHub, a [Complexity Analysis Action](/complexity-analyzers/pt-br/acti já possui a [release `v1.0.0` publicada](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). Ela invoca a mesma CLI, mas tem versionamento independente. Para começar, consulte as [instruções de instalação](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) e os -[exemplos da versão](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). +[exemplos da versão](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). Use um manifesto local de ferramentas para que o workflow restaure uma versão revisada. diff --git a/website/src/content/docs/pt-br/getting-started/choose-product.md b/website/src/content/docs/pt-br/getting-started/choose-product.md index ce8795a..83d4ad7 100644 --- a/website/src/content/docs/pt-br/getting-started/choose-product.md +++ b/website/src/content/docs/pt-br/getting-started/choose-product.md @@ -32,7 +32,7 @@ Para maior reprodutibilidade, use o commit revisado da release no workflow: `rodri-oliveira-dev/complexity-analysis-action@2d807ef29ca03c685d224543a135d8c30dfe2c67`. A tag publicada `@v1.0.0` também está disponível; a referência móvel `@v1` **ainda não foi criada**. Consulte o [guia da Action](/complexity-analyzers/pt-br/action/) -e os [exemplos publicados](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/v1.0.0/examples). Publicar a GitHub Release não +e os [exemplos publicados](https://github.com/rodri-oliveira-dev/complexity-analysis-action/tree/main/examples). Publicar a GitHub Release não comprova, por si só, a disponibilidade da listagem no Marketplace. ## Escolha o MCP quando diff --git a/website/src/content/docs/pt-br/reference/releases.md b/website/src/content/docs/pt-br/reference/releases.md index 5e3ac9f..079d606 100644 --- a/website/src/content/docs/pt-br/reference/releases.md +++ b/website/src/content/docs/pt-br/reference/releases.md @@ -13,7 +13,7 @@ Os pacotes Analyzer, CLI e MCP são consumíveis de forma independente e podem t A [Complexity Analysis Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0), com versionamento independente, foi publicada em 30 de outubro de 2026. Consulte o [guia de instalação da Action](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) para adicioná-la a um workflow do GitHub Actions, ou leia as [notas da release](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). -A tag `@v1.0.0` aponta para o commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`. Para maior reprodutibilidade, utilize esse SHA completo em `uses:`. A referência móvel `@v1` ainda não foi verificada; confirme a existência da tag antes de utilizá-la. A existência da GitHub Release não comprova, por si só, a disponibilidade da listagem no Marketplace. +A tag `@v1.0.0` aponta para o commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`. Para maior reprodutibilidade, utilize esse SHA completo em `uses:`. A referência móvel `@v1` ainda não foi criada; não a utilize até que o alias seja criado. A existência da GitHub Release não comprova, por si só, a disponibilidade da listagem no Marketplace. A Action invoca `ComplexityAnalysis.Tool` e não substitui as versões independentes do Analyzer, da CLI ou do MCP. diff --git a/website/src/content/docs/reference/releases.md b/website/src/content/docs/reference/releases.md index 70e1be1..5417c25 100644 --- a/website/src/content/docs/reference/releases.md +++ b/website/src/content/docs/reference/releases.md @@ -13,7 +13,7 @@ The Analyzer, CLI, and MCP packages are independently consumable and may have di The independently versioned [Complexity Analysis Action v1.0.0](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0) was published on October 30, 2026. Use the [Action installation guide](https://github.com/rodri-oliveira-dev/complexity-analysis-action#quick-start) to add it to a GitHub Actions workflow, or inspect the [release notes](https://github.com/rodri-oliveira-dev/complexity-analysis-action/releases/tag/v1.0.0). -The published `@v1.0.0` tag resolves to commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`. For reproducible automation, reference that full commit SHA in `uses:`. The moving `@v1` reference is not yet verified; do not rely on it without confirming the tag exists. The GitHub release alone does not establish Marketplace listing visibility. +The published `@v1.0.0` tag resolves to commit `2d807ef29ca03c685d224543a135d8c30dfe2c67`. For reproducible automation, reference that full commit SHA in `uses:`. The moving `@v1` alias has not been created; do not use it until that reference exists. The GitHub release alone does not establish Marketplace listing visibility. The Action invokes `ComplexityAnalysis.Tool` and does not replace the separately versioned Analyzer, CLI, or MCP packages.