{"id":23268582,"url":"https://github.com/eclipse-keyple/keyple-api-docs","last_synced_at":"2026-01-18T11:42:58.790Z","repository":{"id":264605779,"uuid":"893158112","full_name":"eclipse-keyple/keyple-api-docs","owner":"eclipse-keyple","description":"Eclipse Keyple project repository centralizing API documentation (Javadoc, Doxygen) from all Keyple libraries","archived":false,"fork":false,"pushed_at":"2025-12-04T10:52:14.000Z","size":146677,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-12-07T18:46:16.495Z","etag":null,"topics":["documentation","doxygen","javadoc","keyple"],"latest_commit_sha":null,"homepage":"https://keyple.org/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eclipse-keyple.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-23T17:27:24.000Z","updated_at":"2025-10-20T09:33:08.000Z","dependencies_parsed_at":"2024-11-25T10:37:19.229Z","dependency_job_id":"d4445a30-a8de-446d-b08a-3249d1728fa2","html_url":"https://github.com/eclipse-keyple/keyple-api-docs","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"29cec5b1b597997e5c9a0b342f4ae2d1c56e29d2"},"previous_names":["eclipse-keyple/keyple-api-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eclipse-keyple/keyple-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipse-keyple","download_url":"https://codeload.github.com/eclipse-keyple/keyple-api-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-api-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28535177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T10:13:46.436Z","status":"ssl_error","status_checked_at":"2026-01-18T10:13:11.045Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","doxygen","javadoc","keyple"],"created_at":"2024-12-19T17:19:53.146Z","updated_at":"2026-01-18T11:42:58.781Z","avatar_url":"https://github.com/eclipse-keyple.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Keyple API Documentation\n\n[![License](https://img.shields.io/badge/License-EPL_2.0-red.svg)](https://opensource.org/licenses/EPL-2.0)\n\nCentral repository for API documentation of all **Eclipse Keyple** libraries, including both **Java** (Javadoc) and\n**C++** (Doxygen) references.\n\nPublished at: [https://docs.keyple.org/](https://docs.keyple.org/)\n\n---\n\n## Table of Contents\n\n- [Architecture](#architecture)\n- [Branch Structure](#branch-structure)\n- [Automated Publication Workflow](#automated-publication-workflow)\n- [Managing Documentation](#managing-documentation)\n- [Maintenance \u0026 Troubleshooting](#maintenance--troubleshooting)\n\n---\n\n## Architecture\n\nThis repository aggregates documentation from multiple Keyple libraries using **Git submodules**. Each library maintains its own documentation in its repository's `doc` branch, and this repository automatically publishes a consolidated view.\n\n### Key Components\n\n1. **Submodules**: Each Keyple library is included as a Git submodule (30+ libraries)\n2. **Workflow**: GitHub Actions automatically updates and publishes documentation\n3. **Version Management**: Old patch versions are automatically cleaned (keeps only latest per minor version)\n4. **UML Documentation**: Automatically extracts and organizes UML diagrams from Java/KMP libraries into dedicated modules\n\n---\n\n## Branch Structure\n\n### `main`\n- **Purpose**: Repository configuration and automation scripts\n- **Contains**:\n  - Workflow definitions (`.github/workflows/`)\n  - Publication script (`.github/scripts/update_and_publish.sh`)\n  - This README\n- **Who modifies**: DevOps/maintainers\n\n### `gh-pages-source`\n- **Purpose**: Source configuration for documentation\n- **Contains**:\n  - Git submodule definitions (`.gitmodules`)\n  - Jekyll configuration (`_config.yml`, `_layouts/`)\n  - Index pages\n- **Who modifies**: When adding/removing libraries\n\n### `gh-pages`\n- **Purpose**: Published documentation (auto-generated, **do not edit manually**)\n- **Contains**:\n  - All extracted documentation from submodules\n  - UML documentation modules\n  - Jekyll site ready for GitHub Pages\n- **Who modifies**: Automated workflow only\n\n---\n\n## Automated Publication Workflow\n\n### Trigger Events\n\nThe workflow runs automatically on:\n- **Manual trigger**: Via GitHub Actions UI\n- **Repository dispatch**: When a library publishes new docs\n\n### Workflow Steps\n\n```mermaid\ngraph LR\n    A[Checkout gh-pages-source] --\u003e B[Update Submodules]\n    B --\u003e C[Clean Old Versions]\n    C --\u003e D[Copy to Clean Repo]\n    D --\u003e E[Extract UML Docs]\n    E --\u003e F[Push to gh-pages]\n```\n\n#### 1. **Update Submodules**\nFetches latest documentation from all library `doc` branches.\n\n#### 2. **Clean Old Patch Versions**\nRemoves outdated patch versions to save space:\n- Keeps: `2.1.0`, `2.2.5`, `3.0.1` (latest per minor)\n- Removes: `2.2.0`, `2.2.1`, `2.2.2`, `2.2.3`, `2.2.4`\n\n#### 3. **Prepare Clean Repository**\nCopies documentation files excluding Git metadata:\n```bash\nrsync -a --exclude='.git' --exclude='.gitmodules'\n```\n\n#### 4. **Extract UML Documentation**\nCreates `-uml-` modules for Java/KMP libraries by extracting existing UML diagrams:\n- `keyple-card-calypso-java-lib` → `keyple-card-calypso-uml-lib`\n- Copies class diagrams (`api_class_diagram.svg`) from source modules\n- Generates index pages with links to diagrams\n\n#### 5. **Force Push to gh-pages**\nPublishes consolidated documentation to GitHub Pages.\n\n### Monitoring\n\nView workflow runs: [Actions \u003e Update Submodules and Publish](../../actions/workflows/update-submodules.yml)\n\nLogs are organized in collapsible groups:\n- Updating submodules\n- Cleaning old patch versions\n- Preparing clean GH Pages repository\n- Extracting UML documentation\n- Pushing to gh-pages\n\n---\n\n## Managing Documentation\n\n### Adding a New Library\n\n1. **Switch to gh-pages-source branch**:\n```bash\ngit checkout gh-pages-source\n```\n\n2. **Add submodule**:\n```bash\ngit submodule add -b doc \\\n  https://github.com/eclipse-keyple/[library-name].git \\\n  [library-name]\n```\n\n3. **Commit and push**:\n```bash\ngit add .gitmodules [library-name]\ngit commit -m \"feat: add documentation for [library-name]\"\ngit push origin gh-pages-source\n```\n\n4. **Trigger workflow**: The documentation will be published automatically on next run.\n\n### Removing a Library\n\n1. **Switch to gh-pages-source branch**:\n```bash\ngit checkout gh-pages-source\n```\n\n2. **Remove submodule**:\n```bash\ngit submodule deinit -f [library-name]\nrm -rf .git/modules/[library-name]\ngit rm -f [library-name]\n```\n\n3. **Commit and push**:\n```bash\ngit commit -m \"feat: remove documentation for [library-name]\"\ngit push origin gh-pages-source\n```\n\n### Manually Triggering Publication\n\n1. Go to [Actions](../../actions/workflows/update-submodules.yml)\n2. Click \"Run workflow\"\n3. Select branch `main`\n4. Click \"Run workflow\"\n\n---\n\n## Maintenance \u0026 Troubleshooting\n\n### Workflow Script\n\nThe publication logic is in: `.github/scripts/update_and_publish.sh`\n\nThe script is automatically fetched from `main` branch during workflow execution. To modify it:\n1. Edit on `main` branch\n2. Push changes\n3. Next workflow run will use updated script\n\n### Monitoring\n\nView workflow runs: [Actions \u003e Update Submodules and Publish](../../actions/workflows/update-submodules.yml)\n\nView logs with GitHub CLI:\n```bash\ngh run list --workflow=update-submodules.yml --limit 5\ngh run view [RUN_ID] --log\n```\n\n## Contributing\n\nPlease read our [contribution guidelines](https://keyple.org/community/contributing/) before submitting any changes.\n\n## License\n\nThis project is licensed under the Eclipse Public License v. 2.0. See [LICENSE](LICENSE) for details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-keyple%2Fkeyple-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipse-keyple%2Fkeyple-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-keyple%2Fkeyple-api-docs/lists"}