Skip to content

feat: split tools#71

Merged
jkowalleck merged 1 commit into
mainfrom
feat/devide-tools
Sep 24, 2025
Merged

feat: split tools#71
jkowalleck merged 1 commit into
mainfrom
feat/devide-tools

Conversation

@jkowalleck

@jkowalleck jkowalleck commented Sep 9, 2025

Copy link
Copy Markdown
Member

fixes #67

  • a new tool.schema.json was created
  • the tools.json was split into individual files in the tools/ folder
  • each file in the tools/ folder follows the new tool.schema.json
  • added automated validators for the files in the tools/ folder
  • added automated processes that assemble the tools.json based on all files in the tools/ folder
  • modified the metaconfigurator config and links to easy file modifications
  • created helpers to split and assemble the tools.json

result:

  • we still maintain the tools.json file
  • we have separate files for each tool, so that it is easy to add/modify tools in parallel

Comment thread README.md
Editing the `tools.json` file manually can be complicated. An alternative is to use
[MetaConfigurator](https://metaconfigurator.github.io/meta-configurator/?schema=https://raw.githubusercontent.com/CycloneDX/tool-center/refs/heads/main/tools.schema.json&data=https://raw.githubusercontent.com/CycloneDX/tool-center/refs/heads/main/tools.json&settings=https://raw.githubusercontent.com/CycloneDX/tool-center/refs/heads/main/metaConfiguratorSettings.json) to make changes then download the edited data.
Creating/editing a file in the `tools/` folder manually can be complicated. An alternative is to use
[MetaConfigurator](https://www.metaconfigurator.org?schema=https://raw.githubusercontent.com/CycloneDX/tool-center/refs/heads/main/schemas/tool.schema.json&settings=https://raw.githubusercontent.com/CycloneDX/tool-center/refs/heads/main/metaConfiguratorSettings.json) to make changes then download the edited data.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@jkowalleck
jkowalleck force-pushed the feat/devide-tools branch 3 times, most recently from 207d2d9 to ffee523 Compare September 10, 2025 13:40
@jkowalleck
jkowalleck marked this pull request as ready for review September 10, 2025 13:43
@jkowalleck
jkowalleck requested a review from a team as a code owner September 10, 2025 13:43
@jkowalleck jkowalleck changed the title [WIP] feat: devide tools feat: split tools Sep 10, 2025

@stevespringett stevespringett left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Overall I think this looks good. However, we may need to change where the Cloudflare Hook is executed. The idea is that whenever tools.json is updated, it will rebuild the public website. That process is now handled in assemble_tools_json.yml.

Comment thread .github/workflows/build_docs.yml Outdated
uses: actions/deploy-pages@v4

- name: Trigger Cloudflare Deploy Hook

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we may need to trigger Cloudflare Deploy hook iin the assemble_tools_json.yml instead.

@jkowalleck jkowalleck Sep 12, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

we have a cloudflare deploy hook in the docs - what does it actually do?

for the changes in tools.json - i would go with a scheduled task for this purpose.
this can be added in a different pullrequest.

PS:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

we have a cloudflare deploy hook in the docs - what does it actually do?

It triggers Cloudflare pages to checkout the website repo and tools.json and rebuild and redeploy the entire website. A scheduled task should be avoided as it will erroneously result in timestamps in sitemap.xml for a "changed" website when there were no actual changes made. I don't know if there are any SEO penalties for this or not, but I'd rather not find out.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

understood.
the publication is triggered via .github/workflows/publish_toolcenter.yml now .

@jkowalleck jkowalleck added the enhancement New feature or request label Sep 12, 2025
@jkowalleck
jkowalleck force-pushed the feat/devide-tools branch 3 times, most recently from aca0368 to bb995f7 Compare September 15, 2025 10:27
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck
jkowalleck merged commit 459bd12 into main Sep 24, 2025
4 checks passed
@jkowalleck
jkowalleck deleted the feat/devide-tools branch September 24, 2025 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[CHORE] split the tools.json into multiple files

2 participants