Skip to content

CI/CD standard: Dependabot and TechDocs (DX-660) - #4

Merged
elmarhepp merged 2 commits into
mainfrom
chore/dx-660-cicd-standard
Oct 28, 2026
Merged

elmarhepp merged 2 commits into
mainfrom
chore/dx-660-cicd-standard

Conversation

@elmarhepp

Copy link
Copy Markdown
Contributor

Brings sample-data up to the CI/CD standard (atlas → handbook/engineering/cicd-standard.md), as part of DX-660.

The gate in ci.yml already meets it: read-only permissions, Node 22 pinned, format, lint, type check and tests of tui/ plus tests/run-lock.sh, no push: main, and only actions/*, which §4.3 lets stay on major tags. It writes the steps out because this repository is public and cannot call the private node-ci.yml. Nothing changes there.

What this adds:

  • .github/dependabot.yml (§4.3, §5): npm in /tui and github-actions, monthly, from the template in revenexx/.github. Minor and patch come grouped, majors on their own. @types/node majors are held to the Node release CI runs (22).
  • TechDocs (§5): mkdocs.yml, a short docs/index.md that points to the README, and backstage.io/techdocs-ref in catalog-info.yaml, so the portal shows the tab "Docs & Decisions".

Not in this PR: the ruleset file (.github/rulesets/). It waits for the decision on required reviews in revenexx/atlas#124.

How to check: after the merge, open https://backstage.revenexx.com/catalog/default/component/sample-data/docs. The first view builds the page. Dependabot's first run shows under Insights → Dependency graph → Dependabot.

🤖 Generated with Claude Code

elmarhepp and others added 2 commits October 28, 2026 15:41
…X-660)

From the template in revenexx/.github, cut to what this repository pins:
npm in tui/ and the actions in ci.yml, both monthly. @types/node stays on
the Node major CI runs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…(DX-660)

mkdocs.yml, a signpost page in docs/ that points to the README, and the
techdocs-ref annotation in catalog-info.yaml.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@elmarhepp
elmarhepp requested a review from a team October 28, 2026 14:41

@alexbystrow alexbystrow left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked at fcdb651: tui/package-lock.json exists, so the npm entry has something to update. docs/tui-overview.png, which docs/index.md embeds, is already in docs/. The techdocs-ref and mkdocs.yml (docs_dir: docs, techdocs-core) match the usual TechDocs setup, and both checks are green.

— Bark, automated on Alexander's behalf

@elmarhepp
elmarhepp merged commit 4b14015 into main Oct 28, 2026
2 checks passed
@elmarhepp
elmarhepp deleted the chore/dx-660-cicd-standard branch October 28, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants