{"id":18672899,"url":"https://github.com/projectsyn/component-hub","last_synced_at":"2025-11-06T23:30:21.929Z","repository":{"id":37417769,"uuid":"379864559","full_name":"projectsyn/component-hub","owner":"projectsyn","description":"Project Syn Commodore Component Hub","archived":false,"fork":false,"pushed_at":"2024-10-29T09:23:50.000Z","size":1199429,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-29T09:51:25.754Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/projectsyn.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-24T09:00:32.000Z","updated_at":"2024-10-28T04:45:27.000Z","dependencies_parsed_at":"2024-04-15T06:26:53.828Z","dependency_job_id":"2fe16d00-8fc9-4b9c-87a8-e2a34cb5da7a","html_url":"https://github.com/projectsyn/component-hub","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectsyn%2Fcomponent-hub","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectsyn%2Fcomponent-hub/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectsyn%2Fcomponent-hub/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/projectsyn%2Fcomponent-hub/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/projectsyn","download_url":"https://codeload.github.com/projectsyn/component-hub/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239513379,"owners_count":19651322,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T09:13:25.128Z","updated_at":"2025-11-06T23:30:21.771Z","avatar_url":"https://github.com/projectsyn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Project Syn Commodore Hub Generator\n\nimage::https://github.com/projectsyn/component-hub/actions/workflows/hub.yml/badge.svg[Build and Deploy Hub,link=https://github.com/projectsyn/component-hub/actions/workflows/hub.yml]\n\nThis project uses the GitHub API to generate an Antora website containing the documentation of all Commodore components and Commodore packages.\n\n== How to Use\n\n. https://github.com/settings/tokens[Create an API token] in GitHub\n. Use the `GITHUB_TOKEN=xxx make` command, where `xxx` is the token retrieved in the previous step.\n. You can use `make clean` to get rid of the generated website.\n\n== Start hacking on the generator\n\nThe generator is implemented in Python.\nThe project uses [Poetry] to manage the Python virtual environment.\nThe project sources environment variables from file `.env` if it exists.\n\n=== Setup\n\nThe `Makefile` provides a target to setup the poetry environment.\n\n[source,console]\n----\nmake setup\n----\n\n=== Run the generator locally\n\nSimply run `make hub` to generate a local copy of the site in `./build/component-hub/_public`\n\nYou can run the individual generation steps in isolation:\n\n* `poetry run component-hub generate antora-site` generates the Antora site from the https://github.com/vshn/antora-bootstrap[VSHN Antora Cookiecutter template].\n* `poetry run component-hub generate index` generates `docs/modules/ROOT/pages/index.adoc` for the component hub.\n* `poetry run component-hub generate nav` generates `docs/modules/ROOT/nav.adoc` for the component hub.\n* `poetry run component-hub generate playbook` generates `playbook.yml` for the component hub.\n\n\n=== Linting and testing\n\nThe `Makefile` provides targets for Python linting and testing.\n\n[source,console]\n----\nmake lint\nmake test\n----\n\nThe lint and test targets expect that the Poetry environment is already initialized.\n\nThe tests require a Github token in environment variable `GITHUB_TOKEN.\nThe tests source environment variables from file `.env` if it exists.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectsyn%2Fcomponent-hub","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprojectsyn%2Fcomponent-hub","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprojectsyn%2Fcomponent-hub/lists"}