Integraatio CI/CD:hen
Tällä sivulla
Päivitetty 3. marraskuuta 2026 perustuen Codex GitHub Action - ja Non-interactive mode -sivuihin Codex-dokumentaation osiossa: vanhentuneet syötteet
task,criteria,scope,frameworkjaapi-keyeivät ole olemassa versiossaopenai/codex-action@v1(korvattu arvoillaopenai-api-key,prompt/prompt-file,sandbox,output-filejne.). Toiminto ei lähetä kommentteja omin päin. Lauseke== failureilman lainausmerkkejä ei toiminut. Lippu--applyon korvattu komennollacodex exec --sandbox workspace-write. Lähteet: Codex GitHub Action · Non-interactive mode.
Codex toimitusputkessasi
Codex ei rajoitu vain kehittäjän manuaalisesti käynnistämiin tehtäviin. Se integroituu CI/CD-putkiisi automatisoiden kehitystehtäviä toimituskierron jokaisessa vaiheessa. Tämä muutos on enemmän kuin ajan säästöä: koodikatselmukset, testien generointi ja virhekorjaukset lakkaavat olemasta yksittäisten henkilöiden kurinalaisuudesta kiinni ja muuttuvat tapahtumien laukaisemiksi putken vaiheiksi, eivät perjantai-iltapäivän hyväntahtoisuudesta riippuviksi tehtäviksi.
Virallinen GitHub-toiminto
OpenAI julkaisee toiminnon openai/codex-action@v1, joka asentaa CLI:n, käynnistää Responses API -välityspalvelimen, kun annat avaimen, ja suorittaa codex exec -komennon määrittämilläsi oikeuksilla. Sen tärkeimmät syötteet:
| Syöte | Rooli |
|---|---|
openai-api-key | Avain, tallennettuna GitHub-salaisuutena (esim. OPENAI_API_KEY) |
prompt tai prompt-file | Ohje joko suoraan tekstissä tai tiedostona repositoriossa – toinen tai toinen, ei molemmat |
sandbox | read-only, workspace-write tai danger-full-access: valitse kapein riittävä laajuus |
model, effort | Malli ja päättelypanostus; jos tyhjä, oletusarvot ovat voimassa |
output-file | Tallentaa Codexin viimeisen viestin myöhempiä vaiheita varten |
codex-args | Lisävalinnat codex exec -komentoa varten |
safety-strategy | Oletusarvo drop-sudo, joka poistaa sudo-komennot ennen suorittamista ja suojaa salaisuuksia muistissa |
Toiminto suoritetaan Linux- tai macOS-suorittimilla (Windowsissa tarvitset asetuksen safety-strategy: unsafe) koodin actions/checkout-vaihdon jälkeen. Se ei julkaise mitään omin päin: se paljastaa Codexin viimeisen viestin final-message-tulosteena, jonka myöhempi vaihe voi julkaista.
Automatisoi katselmus jokaiseen PR:ään
Alla oleva työnkulku noudattaa virallisen esimerkin rakennetta: ensimmäinen työ suorittaa Codexin vain luku -tilassa, ja toinen, jolla on kirjoitusoikeudet PR:iin, julkaisee tuloksen kommenttina. Kriteerisi menevät kehotteeseen (prompt).
# .github/workflows/codex-review.yml
name: Codex Review
on:
pull_request:
types: [opened, synchronize, reopened]
jobs:
codex:
runs-on: ubuntu-latest
permissions:
contents: read
outputs:
final_message: ${{ steps.run_codex.outputs.final-message }}
steps:
- uses: actions/checkout@v5
with:
ref: refs/pull/${{ github.event.pull_request.number }}/merge
fetch-depth: 0
persist-credentials: false
- name: Run Codex
id: run_codex
uses: openai/codex-action@v1
with:
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
sandbox: read-only
prompt: |
Review the changes in this pull request against the base branch.
Priorities: security (injections, missing authentication), performance
(N+1 queries), types (no any), tests (coverage of changes).
Cite the files and lines involved.
post_feedback:
runs-on: ubuntu-latest
needs: codex
if: needs.codex.outputs.final_message != ''
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/github-script@v7
with:
github-token: ${{ github.token }}
script: |
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.payload.pull_request.number,
body: process.env.CODEX_FINAL_MESSAGE,
});
env:
CODEX_FINAL_MESSAGE: ${{ needs.codex.outputs.final_message }}
Kehote ansaitsee enemmän huomiota kuin loput tiedostosta: se muuttaa yleiskatselmuksen prioriteettiesi vastaavaksi tarkasteluksi. Voit siirtää sen YAML-tiedostosta versionhallittuun tiedostoon, esimerkiksi .github/codex/prompts/review.md, johon viitataan parametrilla prompt-file. Yksinkertaisessa PR-katselmuksessa GitHubiin sisäänrakennettu automaattinen katselmus (Oppitunti 11) välttää työnkulun kirjoittamisen kokonaan.
Täytä puuttuvat testit
Toinen työnkulku käsittelee koodia, joka toimitetaan ilman testejä. Tässä Codexin täytyy kirjoittaa työtilaan (sandbox: workspace-write), mutta tulos pysyy ehdotuksena: työnkulku muuttaa sen ladattavaksi patch-tiedostoksi, jonka kehittäjä tarkistaa ja ottaa käyttöön itse.
# .github/workflows/codex-tests.yml
name: Codex Generate Tests
on:
pull_request:
types: [opened]
jobs:
generate-tests:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v5
with:
fetch-depth: 0
persist-credentials: false
- name: Generate missing tests
uses: openai/codex-action@v1
with:
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
sandbox: workspace-write
prompt: |
For every file modified in this pull request that lacks a test,
write the missing tests using Vitest, then run them.
- name: Save the proposed tests as a patch
run: git diff > codex-tests.patch
- uses: actions/upload-artifact@v4
with:
name: codex-tests
path: codex-tests.patch
Kehittäjä pitää hallinnan alusta loppuun: hän noutaa patchin, muokkaa sitä tai hylkää sen. Toiminnon dokumentaatio suosittelee Codexin suorittamista työn viimeisenä vaiheena, jotta myöhemmät vaiheet eivät peri odottamattomia muutoksia – tässä ainoa seuraava vaihe vain lukee erotuksen.
Reagoi CI-virheeseen
Kolmas työnkulku kytkeytyy toisen työnkulun tulokseen. Kun CI epäonnistuu, Codex toistaa testit asiaankuuluvalla commitilla, etsii syyn ja tuottaa diagnoosin mitään työntämättä:
# .github/workflows/codex-diagnose.yml
name: Codex Diagnose CI
on:
workflow_run:
workflows: ["CI"]
types: [completed]
jobs:
diagnose:
if: ${{ github.event.workflow_run.conclusion == 'failure' }}
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v5
with:
ref: ${{ github.event.workflow_run.head_sha }}
persist-credentials: false
- name: Analyze the CI failure
uses: openai/codex-action@v1
with:
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
sandbox: workspace-write
output-file: codex-diagnostic.md
prompt: |
CI failed on this commit. Run the tests, identify the cause of the failure,
and propose a fix without modifying the test logic.
- uses: actions/upload-artifact@v4
with:
name: codex-diagnostic
path: codex-diagnostic.md
Tämä vaatii eniten varovaisuutta. Epäonnistunut testi voi joskus kertoa suunnitteluvirheestä, ja uskottava automaattinen korjaus voi saada sen katoamaan näytöltä ratkaisematta ongelmaa: CI muuttuu taas vihreäksi, mutta ongelma pysyy. Siksi valintana on tarkistettava diagnoosi eikä automaattisesti työnnetty commit.
Kutsu Codex omista skripteistäsi
GitHub Actionsin ulkopuolella codex exec sopii mihin tahansa skriptiin. Oletusarvoisesti se suoritetaan vain luku -hiekalaatikossa; anna sille kirjoitusoikeus lipulla --sandbox workspace-write, kun tehtävä sitä vaatii. Alla oleva pre-commit-koukku merkitsee TypeScript-tiedostot, joilta puuttuu testit, ja generoi sellaisen lennosta:
#!/bin/bash
# Pre-commit hook script
# Check that modified files have tests
CHANGED=$(git diff --cached --name-only --diff-filter=ACM | grep '\.ts$' | grep -v '\.test\.ts$')
for file in $CHANGED; do
test_file="${file%.ts}.test.ts"
if [ ! -f "$test_file" ]; then
echo "⚠️ File without test: $file"
codex exec --sandbox workspace-write "Write tests for $file in $test_file"
git add "$test_file"
fi
done
CI-ympäristössä codex exec käyttää oletusarvoisesti tallennettua tunnistautumista; sen sijaan anna tunnistetiedot eksplisiittisesti käyttämällä erillistä API-avainta.
Kartoita integraatiopisteet
Kun nämä rakennuspalikat ovat paikallaan, ajattele toimituskierron tapahtumien eikä YAML-tiedostojen kautta. Alla olevat viisi skenaariota kattavat yleisimmät tapaukset:
| CI/CD-vaihe | Codex-tehtävä | Laukaisija |
|---|---|---|
| PR avattu | Automaattinen katselmus | pull_request opened |
| PR avattu | Testien generointi | pull_request opened |
| CI-virhe | Analyysi ja korjaus | workflow_run failure |
| Julkaisu | Automaattinen muutosloki | tag push |
| Riippuvuuspäivitys | Yhteensopivuustarkistus | Dependabot PR |
Pidä automaation hallinta käsissäsi
CI/CD-integraatio toimii ilman valvontaa, mikä vaatii joitakin perusvarotoimia. Rajoita sitä, kuka voi laukaista työnkulkuja – oletusarvoisesti vain käyttäjät, joilla on kirjoitusoikeudet, voivat suorittaa toiminnon (käytä allow-users, allow-bots laajentaaksesi tätä eksplisiittisesti). Puhdista syöte PR:istä, commit-viesteistä tai issueista ennen kuin luovutat sen Codexille: piilotettu teksti voi sisältää kehotteinjektion. Käytä minimaalisiin oikeuksiin tarkoitettua API-avainta äläkä kehittäjän henkilökohtaista avainta, jonka hän vie mukanaan yrityksestä lähtiessään rikkoen putkesi. Älä koskaan yhdistä automaattisesti Codexin tuottamaa korjausta: ihmisen tarkistus pysyy porttina päähaaraan. Aseta eksplisiittiset rajat päivittäisille tehtäville ja enimmäiskustannuksille, jotta väärin määritetty korjaussilmukka ei polta kuukausibudjettiasi yön aikana. Pidä lopuksi historiaa CI:ssä suoritetuista Codex-tehtävistä: päivänä, jolloin tuotannossa ilmenee odottamatonta käyttäytymistä, nämä lokit ovat ainoa luotettava johtolankasi.
Keskeiset asiat
- Codex integroituu GitHub Actionsiin ja muihin CI/CD-järjestelmiin
- Automaattinen katselmus PR:iin on yleisin käyttötapa
- Codex voi korjata CI-virheitä automaattisesti
- CLI mahdollistaa integroinnin omoihin skripteihin
- Pidä aina ihminen silmukassa vahvistamassa korjauksia