Upstream OpenAPI spec moved from v0.1.104 (7c0bb6af) to v1.0.0 (ff8a7389). Only delta is removal of OCR confidence-score fields/types, which the SDK never wrapped — no code changes required. The watcher previously tried to commit hash/spec updates to main, but the gitea→github mirror reverts them on every sync, leaving issue #1 with stale hashes across multiple upstream releases. Watcher now skips the push and instead refreshes the open tracking issue's body on each run, posting a comment when upstream moves again while the issue is still open.
133 lines
4.9 KiB
YAML
133 lines
4.9 KiB
YAML
name: Watch Mistral OpenAPI Spec
|
|
|
|
on:
|
|
schedule:
|
|
# Runs daily at 06:00 UTC
|
|
- cron: "0 6 * * *"
|
|
workflow_dispatch: # manual trigger for testing
|
|
|
|
permissions:
|
|
contents: read
|
|
issues: write
|
|
|
|
jobs:
|
|
check-spec:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v5
|
|
|
|
- name: Fetch and compare spec
|
|
id: check
|
|
run: |
|
|
if ! curl --fail -sL https://raw.githubusercontent.com/mistralai/platform-docs-public/main/openapi.yaml -o new-spec.yaml; then
|
|
echo "::error::Failed to download OpenAPI spec"
|
|
exit 1
|
|
fi
|
|
|
|
NEW_HASH=$(sha256sum new-spec.yaml | cut -d' ' -f1)
|
|
|
|
if [ -f .openapi-hash ]; then
|
|
OLD_HASH=$(cat .openapi-hash)
|
|
else
|
|
OLD_HASH="none"
|
|
fi
|
|
|
|
echo "old=$OLD_HASH" >> "$GITHUB_OUTPUT"
|
|
echo "new=$NEW_HASH" >> "$GITHUB_OUTPUT"
|
|
|
|
if [ "$NEW_HASH" != "$OLD_HASH" ]; then
|
|
echo "changed=true" >> "$GITHUB_OUTPUT"
|
|
|
|
# Diff against the in-tree baseline (.openapi-spec.yaml).
|
|
# Maintainer commits a fresh baseline when addressing the issue.
|
|
if [ -f .openapi-spec.yaml ]; then
|
|
diff -u .openapi-spec.yaml new-spec.yaml > /tmp/spec-diff.txt || true
|
|
else
|
|
echo "No baseline .openapi-spec.yaml in repo - commit one to enable diffs." > /tmp/spec-diff.txt
|
|
fi
|
|
else
|
|
echo "changed=false" >> "$GITHUB_OUTPUT"
|
|
fi
|
|
|
|
- name: Open or refresh tracking issue
|
|
if: steps.check.outputs.changed == 'true'
|
|
uses: actions/github-script@v7
|
|
env:
|
|
OLD_HASH: ${{ steps.check.outputs.old }}
|
|
NEW_HASH: ${{ steps.check.outputs.new }}
|
|
with:
|
|
script: |
|
|
const fs = require('fs');
|
|
let diff = fs.readFileSync('/tmp/spec-diff.txt', 'utf8');
|
|
|
|
// Truncate if too long for issue body (GitHub issue body limit is 65536 chars)
|
|
if (diff.length > 50000) {
|
|
diff = diff.substring(0, 50000) + '\n\n... (truncated - view full spec for details)';
|
|
}
|
|
|
|
const oldHash = process.env.OLD_HASH;
|
|
const newHash = process.env.NEW_HASH;
|
|
|
|
const body =
|
|
`The upstream OpenAPI spec has changed and the SDK is out of sync.\n\n` +
|
|
`**Stored hash (.openapi-hash):** \`${oldHash}\`\n` +
|
|
`**Current upstream hash:** \`${newHash}\`\n` +
|
|
`_Last refreshed: ${new Date().toISOString()}_\n\n` +
|
|
`[View upstream spec](https://github.com/mistralai/platform-docs-public/blob/main/openapi.yaml)\n\n` +
|
|
`### Diff vs in-tree baseline\n\`\`\`diff\n${diff}\n\`\`\`\n\n` +
|
|
`### TODO\n` +
|
|
`- [ ] Review spec changes\n` +
|
|
`- [ ] Update SDK types if needed\n` +
|
|
`- [ ] Run tests\n` +
|
|
`- [ ] Bump \`.openapi-hash\` and refresh \`.openapi-spec.yaml\` in same commit\n` +
|
|
`- [ ] Close this issue\n\n` +
|
|
`<sub>This issue body is rewritten by the watcher each run, so the diff and hashes always reflect the latest upstream state.</sub>`;
|
|
|
|
const issues = await github.rest.issues.listForRepo({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
labels: 'openapi-update',
|
|
state: 'open'
|
|
});
|
|
|
|
if (issues.data.length === 0) {
|
|
await github.rest.issues.create({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
title: 'Mistral OpenAPI spec has changed',
|
|
body,
|
|
labels: ['openapi-update']
|
|
});
|
|
return;
|
|
}
|
|
|
|
// Refresh the existing open issue so the diff/hashes never go stale.
|
|
const issue = issues.data[0];
|
|
|
|
// Detect whether upstream moved *again* since the last refresh by
|
|
// parsing the previous "Current upstream hash" out of the issue body.
|
|
const marker = /\*\*Current upstream hash:\*\* `([a-f0-9]{64})`/;
|
|
const prev = (issue.body || '').match(marker);
|
|
const movedAgain = prev && prev[1] !== newHash;
|
|
|
|
await github.rest.issues.update({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: issue.number,
|
|
body
|
|
});
|
|
|
|
if (movedAgain) {
|
|
await github.rest.issues.createComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: issue.number,
|
|
body:
|
|
`Upstream spec moved again since this issue was last refreshed.\n\n` +
|
|
`Previous upstream hash: \`${prev[1]}\`\n` +
|
|
`New upstream hash: \`${newHash}\`\n\n` +
|
|
`Issue body has been updated to the latest diff.`
|
|
});
|
|
}
|