Generera och använd regelböcker med Modernize CLI

Regelböcker fångar upp din organisations moderniseringsprinciper i Markdown-filer som moderniseringsagenten för GitHub Copilot använder vid utvärdering, planering och genomförande. Använd en regelbok för att definiera skyddsmekanismer, förbjudna mönster, nödvändiga programfunktioner, anpassad tillämpning av kompetenser samt målramverk och Azure tjänster i flera program.

I den här artikeln använder du Modernize CLI för att generera en regelbok från en policykällfil, lagra den i en central GitHub lagringsplats och tillämpa den på ett programs moderniseringsplan.

Prerequisites

  • En GitHub Copilot prenumeration: Kostnadsfri, Pro, Pro+, Business eller Enterprise.
  • GitHub CLI (gh) version 2.45.0 eller senare. För installationsinstruktioner, se GitHub CLI.
  • Modernize CLI. Installationsinstruktioner finns i Installera och använda moderniseringsagenten.
  • En central GitHub lagringsplats för genererade regelböcker. Du behöver behörighet att pusha till det här repositoriet och läsa det när du skapar moderniseringsplaner.
  • En lokal utcheckning av ett mål-.NET- eller Java-applikationsrepository med läs- och skrivbehörighet.
  • En Markdown-fil som beskriver organisationens moderniseringsprinciper.

Autentisera med GitHub innan du fortsätter:

gh auth login

För allmänna plattformskrav, se Installera och använda moderniseringsagenten.

Konfigurera regelböcker

Skapa en privat repository för att lagra den genererade regelboken eller använd en befintlig repository. Ersätt <org> med din GitHub organisation i den här artikeln:

gh repo create <org>/modernize-rulebooks --private

Peka CLI på det här repot. Välj antingen en konfigurationsfil eller en miljövariabel.

Använda en konfigurationsfil

För en inställning som bevaras mellan terminalsessioner lägger du till följande egenskap i din konfigurationsfil på användarnivå. Om filen redan finns, sammanfogar du den här egenskapen med dess befintliga inställningar i stället för att ersätta den.

{
  "portfolio_url": "https://github.com/<org>/modernize-rulebooks"
}

Konfigurationsfilernas platser är:

Scope Location
Användare, Windows %USERPROFILE%\.modernize\config.json
Användare, Linux eller macOS ~/.modernize/config.json
Lagringsplats .github/modernize/config.json

Miljövariabler har företräde framför konfiguration på användarnivå, vilket har företräde framför konfiguration på arkivnivå.

Använda en miljövariabel

Om du vill konfigurera regelbokslagringsplatsen för den aktuella terminalsessionen anger MODERNIZE_PORTFOLIO_URL du i kommandotolken där du kör Modernize CLI.

$env:MODERNIZE_PORTFOLIO_URL = "https://github.com/<org>/modernize-rulebooks"

Förbered en källfil för policy

Skapa en Markdown-fil med namnet agent-rulebook.md som beskriver de standarder som agenten ska tillämpa under planering och körning. Inkludera dina obligatoriska målplattformar, förbjudna mönster och krav för identitet, observerbarhet, hälsoslutpunkter, hemlighetshantering och databasåtkomst i förekommande fall.

I följande exempel visas policyinnehåll. Anpassa den efter organisationens krav. det är inte ett obligatoriskt filschema.

# Modernization policies

## Target platform

- Migrate the application to Azure Container Apps.

## Identity and secrets

- Use managed identities for Azure service access where supported.
- Don't commit credentials or connection secrets to source control.

## Application operations

- Provide health endpoints for the application.
- Include application telemetry without logging secrets or personal data.

## Validation

- Build the application and run its tests after code changes.

Generera och publicera en regelbok

Kör följande kommando från katalogen som innehåller din principkällfil. Använd samma lagringsplats-URL som du har konfigurerat för portfolio_url eller MODERNIZE_PORTFOLIO_URL:

modernize rulebook create --file-path ./agent-rulebook.md --push-git-url https://github.com/<org>/modernize-rulebooks

Kommandot bearbetar dina källprinciper till agentoptimerade Markdown-filer och skickar dem till den centrala lagringsplatsen:

File Purpose
charter.md Definierar moderniseringsstadgan på hög nivå.
targets.md Definierar målplattformar och ramverk.
policies.md Definierar principregler för modernisering.

Granska de genererade filerna på den centrala lagringsplatsen innan du använder dem för att vägleda programändringar. Kontrollera att de återspeglar kraven i källfilen.

Skapa en plan som använder regelboken

I samma konfigurerade terminalsession går du till målprogramlagringsplatsen och skapar en plan:

cd /path/to/your-app
modernize plan create "migrate to Azure Container Apps"

När du konfigurerar URL:en för den centrala lagringsplatsen hämtar CLI automatiskt charter.md, targets.md och policies.md och använder dem som kontext för planering. Du behöver inget extra regelboksalternativ i kommandot plan.

Med standardplanens namn inkluderar de genererade utdata:

.github/modernize/modernization-plan/
    plan.md
    rulebook-compliance.md
    .metadata/
        tasks.json
        rulebook-metadata.json

Granska plan.md och rulebook-compliance.md innan du kör planen. Efterlevnadsrapporten tillhandahåller en översikt regel för regel så att du kan kontrollera hur planen hanterar dina principer.

Köra och validera planen

När du har granskat planen och efterlevnadsrapporten, kör du:

modernize plan execute

Agenten använder dina regelboksprinciper under körningen. Den kör de planerade uppgifterna, gör kodändringar, validerar byggen, söker efter vanliga sårbarheter och exponeringar (CVE) och genomför ändringar.

Granska de resulterande kodändringarna och valideringsresultaten mot organisationens principer. Regelbokskontext och en genererad efterlevnadsrapport ersätter inte din granskning av programmet.

Felsöka regelbokskonfiguration

Om CLI inte tillämpar regelboken, kontrollerar du följande:

  • Bekräfta att portfolio_url eller MODERNIZE_PORTFOLIO_URL pekar på lagringsplatsen där du publicerade den genererade regelboken.
  • Sök efter miljövariabler som åsidosätter din konfigurationsfil.
  • Om du använde miljövariabler kör du skapande av plan från terminalsessionen där du ställde in dem.
  • Bekräfta att ditt autentiserade GitHub konto kan läsa regelbokslagringsplatsen och har skrivåtkomst när du genererar och publicerar en regelbok.
  • Granska de genererade regelboksfilerna och planens efterlevnadsrapport för att kontrollera vilka policyer som representeras.