chore(golden-path): compliance artifacts + AGENTS.md + CI augmentation#213
Conversation
|
Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖 Please select which version do you want to release:
And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.
|
|
Beep boop 🤖 Thank you so much for keeping our documentation up-to-date ❤️ |
7dc3aea to
6bb527d
Compare
|
Bring vtex.search up to VTEX Engineering Golden Path compliance and register it as the seventh repo in the Intelligent Search IO multi-repo workspace at vtex-apps/is-io-specs. Added: - Makefile (vtex-io template; lint via npx eslint with no --fix; test/ coverage print "no runner configured" rather than failing — there is no Jest/Mocha set up in this repo today) - AGENTS.md (canonical agent guidance) + CLAUDE.md symlink to AGENTS.md - README.md at repo root with the five Golden Path H2 sections (Prerequisites, How to run, How to test, How to publish, Documentation); the deep block reference stays at docs/README.md - docs/glossary.md and docs/data-model.md (repo-local; cross-repo glossary/architecture live at the parent is-io-specs repo) - SECURITY.md (security@vtex.com) - .mcp.json (GitHub MCP) - .nvmrc (12, matches vtex.search-result) - .github/dependabot.yml (npm root, npm /react, github-actions; weekly) Changed: - .editorconfig: add [Makefile] indent_style=tab - .github/CODEOWNERS: add global owner @vtex-apps/intelligent-search-apps; preserve messages/ (localization); add docs/ (technical-writers) - .gitignore: spec-kit ignore block (cross-repo specs live at vtex-apps/is-io-specs) - .github/workflows/pull-request.yml: add danger-ci + io-app-test + lint jobs while preserving the existing Cypress E2E job Notes: - AGENTS.md documents the legacy node/ folder (no `node` builder is declared in manifest.json, so Toolbelt does not package it). Removing it should be a deliberate follow-up PR. - This repo is part of the is-io-specs multi-repo workspace. SDD Lite applies locally; SDD Full lives at the parent. No .specify/ here because the repo is public. Co-authored-by: Cursor <cursoragent@cursor.com>
6bb527d to
a24c201
Compare
Summary
Bring
vtex.searchup to the VTEX Engineering Golden Path compliance and register it as the seventh repo in the Intelligent Search IO multi-repo workspace atvtex-apps/is-io-specs.This is a scaffolding-only PR: it adds project-level metadata (Makefile, AGENTS.md, README at root, SECURITY.md, dependabot, MCP config, glossary/data-model docs) and augments CI with the standard
danger-ci+io-app-test+lintjobs. No application code is touched andCHANGELOG.mdis not modified.What's added
Makefilelintcallsnpx eslintdirectly (no--fix, per Golden Path);test/coverageprint "no runner configured" since this repo has no Jest/Mocha setup today.AGENTS.mdnode/folder.CLAUDE.mdAGENTS.md(so Claude Code, Cursor, etc. see the same guidance without duplication).README.md(root)docs/README.md.docs/glossary.md,docs/data-model.mdSECURITY.mdsecurity@vtex.compolicy..mcp.json.nvmrc12— matchesvtex.search-resultand the existing dependency tree (TypeScript 3.9.7, eslint 6/7)..github/dependabot.yml/react, and github-actions.What's changed
.editorconfig— add[Makefile] indent_style = tab..github/CODEOWNERS— add global owner@vtex-apps/intelligent-search-apps; preservemessages/ @vtex-apps/localization; adddocs/ @vtex-apps/technical-writers..gitignore— add a spec-kit ignore block. Because this repo is public, it does NOT carry a local.specify/— cross-repo specs live atvtex-apps/is-io-specs(see Multi-repo spec-kit extension)..github/workflows/pull-request.yml— adddanger-ci,io-app-test, andlintjobs alongside the existingCypressE2E job. Thedanger-cijob is configured withREQUIRE_CHANGELOG_VERSION: false, so this PR does not need a CHANGELOG entry of its own.package.json+yarn.lock— bumpeslint(^7.12.1→^7.14.0),eslint-config-vtex(^12.3.2→^12.8.10), andeslint-config-vtex-react(^6.3.2→^6.8.2) to match the working siblingvtex.search-result. Without this bump,yarn lintcrashes withConfiguration for rule "@typescript-eslint/ban-ts-comment" is invalidbecause the older lockfile resolves@typescript-eslint/eslint-plugin@4.8.2, whose rule schema does not match whateslint-config-vtex@12.8.xwrites. The refreshed lockfile resolves@typescript-eslint/eslint-plugin@4.33.0andeslint@7.32.0, same as the sibling repo.Lint job —
continue-on-error: trueThe
lintjob is configured withcontinue-on-error: truebecausevtex.searchcarries pre-existing lint debt (~9 errors + ~54 warnings underreact/components/,react/utils/,react/typings/) that this PR explicitly does not fix. The job runs on every PR and surfaces the findings, but does not block merges until a dedicated cleanup PR addresses the debt.Notes
node/folder.node/package.jsonandnode/yarn.lockexist butmanifest.jsondeclares nonodebuilder, so Toolbelt does not package this folder. AGENTS.md documents it as dead. Removing it should be a deliberate follow-up PR.make testprints a notice rather than failing. Adding a Jest setup is a deliberate engineering decision the team should make explicitly (it would also unlock a coverage threshold matching siblings).biggyaccount viavtex/search-tests.CHANGELOG.mdentry. Per request, this scaffolding PR does not touchCHANGELOG.md; release-worthy changes will be logged at release time.Companion PR
vtex-apps/is-io-specs#5— addsvtex.searchto the multi-repo workspace plumbing (repos.yml, .code-workspace, Makefile, AGENTS.md/README/architecture).Test plan
make helplists the targetsyarn install && yarn lintruns without crashing (will report pre-existing findings; that's expected)danger-cipasses (no CHANGELOG version requirement)lintjob runs and reports findings but does not block merge (continue-on-error: true)io-app-testaction runs (no Jest config, so it's expected to be a no-op)Cypresscontinues to run as beforecat CLAUDE.mdresolves through the symlink toAGENTS.md