Skip to content

refactor: Catalog update script#292

Merged
muchzill4 merged 20 commits into
arm:mainfrom
muchzill4:decouple-models
Jun 10, 2026
Merged

refactor: Catalog update script#292
muchzill4 merged 20 commits into
arm:mainfrom
muchzill4:decouple-models

Conversation

@muchzill4

Copy link
Copy Markdown
Contributor

Changes

  • Sever the update scripts coupling with topo internal
  • Refactor template update scripts to separate GitHub source metadata, GitHub fetching, parsing, and writing concerns
  • Make GITHUB_TOKEN optional, warning about possible rate limiting instead of failing immediately
  • Resolve the catalog output path relative to the repo root so the script works from subdirectories

Going forward / known issues

  • Decide what to do when a single template fails to update (right now it will be dropped)
  • Validate the written catalog is schema compatible (we used to check x-topo.name, but we should be stricter)
  • Organise catalog.*.json so that it's not internal to topo
  • Source template list not from a const, but a file sibling to above
  • Rename ref to sha everywhere and actually store sha's instead of main
  • Setup CI job to run updater periodically

muchzill4 added 16 commits June 9, 2026 13:34
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
@muchzill4 muchzill4 requested a review from a team as a code owner June 9, 2026 12:45
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>

@awphi awphi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

One last thing I was thinking about not changed here though - should the generated catalog JSON's schema link point to the schema at the ref from which it was generated?

Comment thread scripts/update_templates/github_source.go Outdated
Comment thread scripts/update_templates/main.go
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
Signed-off-by: Bartek Mucha <bartosz.mucha@arm.com>
@muchzill4

Copy link
Copy Markdown
Contributor Author

One last thing I was thinking about not changed here though - should the generated catalog JSON's schema link point to the schema at the ref from which it was generated?

The plan is to use versioned schema eventually, I think pinning to a concrete ref will happen then.

@muchzill4 muchzill4 merged commit 431e7be into arm:main Jun 10, 2026
5 checks passed
@muchzill4 muchzill4 deleted the decouple-models branch June 10, 2026 12:30
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