Skip to content

Commit 97ca70b

Browse files
committed
Small update in workflow.
1 parent e2a2ddb commit 97ca70b

2 files changed

Lines changed: 19 additions & 23 deletions

File tree

.github/workflows/sync-mcrdocs.lock.yml

Lines changed: 11 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/workflows/sync-mcrdocs.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
emoji: 📝
33
name: Sync mcrdocs portal docs
4-
description: When a devcontainer image changes, open a draft PR in kaniska244/mcrdocs updating the portal docs to match.
4+
description: When a devcontainer image changes, open a draft PR in Kaniska244/mcrdocs updating the portal docs to match.
55
on:
66
push:
77
branches: [main]
@@ -15,6 +15,7 @@ on:
1515
required: false
1616

1717
permissions:
18+
copilot-requests: write
1819
contents: read
1920
pull-requests: read
2021

@@ -43,17 +44,17 @@ safe-outputs:
4344

4445
## Goal
4546
When one or more devcontainer images change in this repository, update the
46-
corresponding portal documentation in `kaniska244/mcrdocs` so it accurately
47+
corresponding portal documentation in `Kaniska244/mcrdocs` so it accurately
4748
reflects the current image definitions, and open a **draft** pull request there
4849
for human review.
4950

50-
## Source of truth (this repo: kaniska244/images)
51+
## Source of truth (this repo: Kaniska244/images)
5152
For each changed image under `src/<image>/`:
5253
- `manifest.json` — authoritative for `version`, `variants`,
5354
`build.variantTags`, and `build.architectures`.
5455
- `README.md` — supporting prose for that image.
5556

56-
## Target files (in kaniska244/mcrdocs)
57+
## Target files (in Kaniska244/mcrdocs)
5758
- Per-image: `teams/devcontainers/README.<image>.portal.md`
5859
- Aggregate index: `teams/devcontainers/README.dev-containers.md`
5960

@@ -62,7 +63,7 @@ For each changed image under `src/<image>/`:
6263
run manually). Base image is split across `src/base-alpine`,
6364
`src/base-debian`, and `src/base-ubuntu`.
6465
2. For each changed image, read BOTH the updated `manifest.json` in this repo
65-
AND the current target doc in `kaniska244/mcrdocs`.
66+
AND the current target doc in `Kaniska244/mcrdocs`.
6667
3. Update the tag/variant lists, version references, OS variants, and
6768
architecture notes so they match the manifest. Normalize tags for humans:
6869
strip the `image:` prefix and expand/remove the `${VERSION}` and
@@ -77,10 +78,10 @@ For each changed image under `src/<image>/`:
7778
6. While editing, fix obvious inconsistencies you encounter — for example the
7879
`debain-13` typo in the `cpp` entry, jumbled `python` tag ordering, and the
7980
stale `java` `0.205.0` / `bullseye` release-tags example.
80-
7. Open a single **draft** pull request in `kaniska244/mcrdocs` with a summary of
81+
7. Open a single **draft** pull request in `Kaniska244/mcrdocs` with a summary of
8182
what changed per image, so a maintainer can review and mark it ready.
8283

8384
## Constraints
84-
- Only modify files under `teams/devcontainers/**` in `kaniska244/mcrdocs`.
85+
- Only modify files under `teams/devcontainers/**` in `Kaniska244/mcrdocs`.
8586
- Do not invent tags or versions that are not present in the manifests.
8687
- Keep the PR focused and reviewable.

0 commit comments

Comments
 (0)