{"id":22741343,"url":"https://github.com/eclipse-keyple/keyple-actions","last_synced_at":"2026-05-05T05:34:29.217Z","repository":{"id":264604506,"uuid":"893158080","full_name":"eclipse-keyple/keyple-actions","owner":"eclipse-keyple","description":"Eclipse Keyple project repository containing reusable GitHub Actions for Keyple projects","archived":false,"fork":false,"pushed_at":"2024-12-02T08:36:39.000Z","size":30,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-05T06:26:57.420Z","etag":null,"topics":["automation","ci-cd","github-actions","keyple"],"latest_commit_sha":null,"homepage":"https://keyple.org/","language":"Python","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":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":"2024-11-23T17:27:19.000Z","updated_at":"2024-11-25T13:06:09.000Z","dependencies_parsed_at":"2024-11-25T15:32:20.802Z","dependency_job_id":null,"html_url":"https://github.com/eclipse-keyple/keyple-actions","commit_stats":null,"previous_names":["eclipse-keyple/keyple-actions"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-actions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-actions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-actions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eclipse-keyple%2Fkeyple-actions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eclipse-keyple","download_url":"https://codeload.github.com/eclipse-keyple/keyple-actions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246273553,"owners_count":20750906,"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":["automation","ci-cd","github-actions","keyple"],"created_at":"2024-12-11T00:09:53.053Z","updated_at":"2026-05-05T05:34:29.212Z","avatar_url":"https://github.com/eclipse-keyple.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Eclipse Keyple Reusable Workflows and Composite Actions\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nThis repository contains all **GitHub Actions** and **reusable workflows** for the `eclipse-keyple` organization. It's structured to separate **custom composite actions**, **reusable workflows**, and to clearly mark **deprecated** items.\n\n---\n\n## 🔁 Reusable Workflows\n\nThese workflows can be invoked in any org repository via `workflow_call`.\n\n| Name               | Description                                                      | Path                                                |\n|--------------------|------------------------------------------------------------------|-----------------------------------------------------|\n| Build and Test     | Build and test Java/Gradle projects with license verification    | `.github/workflows/reusable-build-and-test.yml`     |\n| C++ Build and Test | Build and test C++ projects across Linux, macOS, and Windows     | `.github/workflows/reusable-cpp-build-and-test.yml` |\n| Publish Snapshot   | Publish snapshot versions to Maven Central                       | `.github/workflows/reusable-publish-snapshot.yml`   |\n| Publish Release    | Publish official releases to Maven Central with GPG signing      | `.github/workflows/reusable-publish-release.yml`    |\n| Publish Doxygen    | Generate and publish Doxygen documentation (C++) to `doc` branch | `.github/workflows/reusable-publish-doxygen.yml`    |\n\n**Workflow Logic**:\n- **Build and Test**: Sets up Java environment, runs Gradle build, and verifies dependency license compliance.\n- **C++ Build and Test**: Builds C++ projects using CMake across three platforms (Linux with GCC, macOS with Clang, Windows with Clang/Visual Studio 2022). Automatically installs required dependencies (clang, cmake, cppcheck, clang-format, clang-tidy, gcc, pre-commit) and supports optional extra Linux dependencies. Runs tests on Linux/macOS if a test executable name is provided.\n- **Publish Snapshot**: Validates version is not already released, builds the project, publishes to Maven Central Snapshots, and updates documentation.\n- **Publish Release**: Verifies version consistency, signs artifacts with GPG, publishes to Maven Central, triggers automatic upload, and updates documentation.\n- **Publish Doxygen**: Extracts repository metadata and invokes the `doxygen` action to generate and deploy documentation.\n\n---\n\n## 🔧 Internal Composite Actions\n\nThese actions live under `actions/` and encapsulate reusable complex workflows.\n\n| Name                 | Description                                             | Path                                      | Status     |\n|----------------------|---------------------------------------------------------|-------------------------------------------|------------|\n| doxygen              | Generate and publish Doxygen documentation (C++ API)    | `actions/doxygen/action.yml`              | **Active** |\n| dash-licenses        | Verify dependency license compliance using Eclipse Dash | `actions/dash-licenses/action.yml`        | **Active** |\n| update-documentation | Generate and push Javadoc to `doc` branch               | `actions/update-documentation/action.yml` | **Active** |\n\n**Composite Action Logic**:\n- **doxygen**: Installs Python and dependencies, validates and patches Doxyfile, generates documentation via Doxygen, prepares versioned directory structure, deploys to `doc` branch, and triggers centralized documentation update.\n- **dash-licenses**: Sets up Java, generates Gradle lockfile (`gradle.lockfile`), downloads Eclipse Dash tool, verifies dependency licenses, and archives compliance report.\n- **update-documentation**: Prepares Javadoc via shell script, commits and pushes to `doc` branch, then triggers centralized documentation update.\n\n---\n\n## 📘 Usage Examples\n\n```yaml\nname: Publish Snapshot\n\non:\n  push:\n    branches: [ main ]\n\njobs:\n  publish:\n    uses: eclipse-keyple/keyple-actions/.github/workflows/reusable-publish-snapshot.yml@main\n    secrets:\n      CENTRAL_SONATYPE_TOKEN_USERNAME: ${{ secrets.CENTRAL_SONATYPE_TOKEN_USERNAME }}\n      CENTRAL_SONATYPE_TOKEN_PASSWORD: ${{ secrets.CENTRAL_SONATYPE_TOKEN_PASSWORD }}\n      ORG_GITHUB_BOT_TOKEN: ${{ secrets.ORG_GITHUB_BOT_TOKEN }}\n```\n\n```yaml\nname: Build and Test\n\non:\n  pull_request:\n\njobs:\n  build:\n    uses: eclipse-keyple/keyple-actions/.github/workflows/reusable-build-and-test.yml@main\n```\n\n```yaml\nname: C++ Build and Test\n\non:\n  pull_request:\n  push:\n    branches: [ main ]\n\njobs:\n  build:\n    uses: eclipse-keyple/keyple-actions/.github/workflows/reusable-cpp-build-and-test.yml@main\n    with:\n      test_executable_name: 'my-test-app'  # Optional: name of the test executable to run\n      extra_linux_deps: 'libssl-dev'       # Optional: additional Linux dependencies\n```\n\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 MIT License. See [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-keyple%2Fkeyple-actions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feclipse-keyple%2Fkeyple-actions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feclipse-keyple%2Fkeyple-actions/lists"}