Add workflow for library publishing and update documentation #18
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds Maven publishing configuration for the SimQ library module and updates the project version to 2025.4.0. It introduces GitHub Packages integration for both the SimFace and SimQ libraries, along with a new GitHub Actions workflow for automated publishing.
- Added Maven publishing configuration to the SimQ module
- Updated project version from 2025.3.2 to 2025.4.0 across all relevant files
- Created a new GitHub Actions workflow for publishing to GitHub Packages with automated testing
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| simq/build.gradle.kts | Added Maven publishing configuration with project metadata and GitHub Packages repository setup |
| simq/README.md | New documentation file describing SimQ's features, installation, usage, and API reference |
| build.gradle.kts | Updated project version from 2025.3.2 to 2025.4.0 |
| README.md | Updated installation version reference from 2025.2.0 to 2025.4.0 |
| .github/workflows/publish.yml | New workflow for publishing packages with test execution and emulator testing |
| .github/workflows/android-tests.yml | Added workflow_call trigger to enable reusable workflow |
Comments suppressed due to low confidence (1)
.github/workflows/publish.yml:1
- The workflow runs tests twice - once through the reusable 'android-tests.yml' workflow (line 9) and again in the publish job (lines 42-61). The 'Build libraries' and 'Run Android Tests' steps (lines 42-61) are redundant since the 'run-tests' job at line 7-10 already executes the test suite. These duplicate test execution steps should be removed from the publish job.
name: Publish to GitHub Packages
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Parameters Reference | ||
|
|
||
| ### calculateFaceQuality() |
There was a problem hiding this comment.
Fine for now, but I would suggest adding Dokka and generating documentation based on code comments, as this will get outdated sooner or later.
| java-version: "17" | ||
|
|
||
| - name: Cache Gradle packages | ||
| uses: actions/cache@v3 |
There was a problem hiding this comment.
IIRC, there was a v4 of this action, not sure how critical the changes are.
There was a problem hiding this comment.
I will leave it at v3 for now to be consistent with the other workflows
| run: chmod +x gradlew | ||
|
|
||
| - name: Build libraries | ||
| run: ./gradlew build |
There was a problem hiding this comment.
Does this build both libraries or only SimFace?
There was a problem hiding this comment.
It should build both; that's how it worked when running it locally
No description provided.