Update project configurations, CI workflows, and licensing #1
Conversation
- Deleted `CLEAN_CODE_REFACTORING_SUMMARY.md`, `DOCUMENTATION_SUMMARY.md`, and `DOCUMENTATION_UPDATE.md`. - These files are no longer relevant as all changes are now reflected in the project and its updated documentation.
- Configured distribution management for releases and snapshots. - Added repositories for accessing reposilite snapshots and releases.
- Introduced a release script to automate common release tasks for nostr-java-bom. - Added a GitHub Actions workflow for handling releases, including validation and publishing steps. This enhances the release process and ensures consistency in versioning and deployment.
- Introduce GitHub Actions workflows for continuous integration. - Includes build process with Maven and code quality checks using Qodana. - Artifacts for test reports and coverage are uploaded to Codecov. Refs: <issue/PR links>
- Adjusted the branch settings for the CI workflow to specify 'main' as the primary branch. - Updated the Qodana action version to ensure the latest features and fixes are utilized.
- Deleted `REFACTORING_SUMMARY.md` as the file is no longer relevant. - All changes are fully reflected in the project's codebase and documentation.
- Updated the license from GNU Affero General Public License to MIT License. - This change simplifies the licensing terms and enhances compatibility with other projects.
- Added properties for slf4j, jsr305, maven compiler, and maven surefire plugin versions. - Refactored dependencies to use the new properties for better maintainability.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces release automation tooling, build configuration improvements, and organizational cleanup. The changes prepare the project for automated releases to Maven Central and update the license from AGPL-3.0 to MIT.
- Adds automated release script and GitHub Actions workflows for CI/CD
- Updates build configuration with centralized version properties and distribution management
- Changes license from AGPL-3.0 to MIT
- Removes temporary documentation files
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/release.sh | New automation script for version bumping, verification, tagging, and publishing |
| pom.xml | Centralizes dependency versions as properties, adds distribution management and custom Maven repositories |
| LICENSE | Replaces AGPL-3.0 with MIT License |
| README.md | Updates artifact ID from "bips" to "bip-utils" and adds documentation structure section |
| .github/workflows/release.yml | Automates releases triggered by version tags |
| .github/workflows/ci.yml | CI workflow for build verification and code coverage |
| .github/workflows/google-java-format.yml | Auto-formatting for Java code on master branch |
| .github/workflows/enforce_conventional_commits.yml | Enforces conventional commit format on PRs |
| .github/workflows/code-quality.yml | Integrates Qodana static analysis |
| .github/dependabot.yml | Configures Dependabot with custom Maven registries |
| REFACTORING_SUMMARY.md | Removed temporary refactoring documentation |
| DOCUMENTATION_UPDATE.md | Removed temporary documentation update log |
| DOCUMENTATION_SUMMARY.md | Removed temporary documentation summary |
| CLEAN_CODE_REFACTORING_SUMMARY.md | Removed temporary clean code summary |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| $no_docker && mvn_args=(-q -DnoDocker=true -P "$profile" deploy) | ||
| $skip_tests && mvn_args=(-q -DskipTests -P "$profile" deploy) | ||
| if $no_docker && $skip_tests; then mvn_args=(-q -DskipTests -DnoDocker=true -P "$profile" deploy); fi |
There was a problem hiding this comment.
The mvn_args array is being completely replaced rather than incrementally built. This logic doesn't properly combine flags when both --no-docker and --skip-tests are used individually, and the final condition overrides previous assignments. Consider building the array incrementally: mvn_args=(-q -P \"$profile\" deploy) followed by $no_docker && mvn_args+=(-DnoDocker=true) and $skip_tests && mvn_args+=(-DskipTests) to avoid duplication and correctly handle all flag combinations.
| $no_docker && mvn_args=(-q -DnoDocker=true -P "$profile" deploy) | |
| $skip_tests && mvn_args=(-q -DskipTests -P "$profile" deploy) | |
| if $no_docker && $skip_tests; then mvn_args=(-q -DskipTests -DnoDocker=true -P "$profile" deploy); fi | |
| if $no_docker; then | |
| mvn_args+=(-DnoDocker=true) | |
| fi | |
| if $skip_tests; then | |
| mvn_args+=(-DskipTests) | |
| fi |
.github/workflows/code-quality.yml
Outdated
| pull_request: | ||
| push: | ||
| branches: # Specify your branches here | ||
| - main # The 'main' branch |
There was a problem hiding this comment.
The branch name 'main' in the comment doesn't match the actual branch 'develop' specified below. The workflow is configured to run on 'develop' but the comment says 'main', which could cause confusion about which branches trigger this workflow.
| - main # The 'main' branch | |
| - main # The 'main' and 'develop' branches |
| on: | ||
| push: | ||
| branches: | ||
| - master |
There was a problem hiding this comment.
[nitpick] This workflow only runs on the 'master' branch, but other workflows in this PR use both 'master' and 'develop'. Consider whether auto-formatting should also run on 'develop' branch for consistency, or document why it's intentionally limited to 'master'.
| - master | |
| - master | |
| - develop |
Qodana Community for JVM8 new problems were found
☁️ View the detailed Qodana report Contact Qodana teamContact us at qodana-support@jetbrains.com
|
- Changed the branch name from 'main' to 'master' in the code quality configuration. - This aligns with the current branch naming conventions used in the repository.
1 participant
Summary
This pull request introduces several updates and improvements to the project:
pom.xmlto use properties for better maintainability.REFACTORING_SUMMARY.md,CLEAN_CODE_REFACTORING_SUMMARY.md,DOCUMENTATION_SUMMARY.md,DOCUMENTATION_UPDATE.md) as they are no longer relevant.2025.2.Checklist
Additional Notes
These updates significantly enhance project maintainability, compatibility, and automation, aligning the project with modern development workflows.