feat: github integration #122
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request introduces comprehensive GitHub integration features, including automated workflows, issue templates, and community health files. The PR modernizes the repository's GitHub configuration by adding CI/CD workflows, dependency management automation, and structured issue reporting templates.
Changes:
- Updated GitHub Actions workflows for CI and Maven Central releases with newer action versions
- Added structured YAML-based issue templates for bugs, features, and questions
- Introduced Dependabot configuration for automated dependency updates
- Added community health files (CONTRIBUTING.md, CODEOWNERS)
- Reformatted LICENSE.md with improved readability
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| LICENSE.md | Reformatted Apache 2.0 license with improved spacing and line numbering |
| .github/workflows/release_workflow.yml | Modernized release workflow with updated actions, GPG signing, and Maven Central deployment |
| .github/workflows/build_workflow.yml | Updated CI workflow with newer actions, path-ignore filters, and branch name changes |
| .github/dependabot.yml | Added automated dependency management for Maven and GitHub Actions |
| .github/PULL_REQUEST_TEMPLATE.md | Simplified PR template with cleaner structure |
| .github/ISSUE_TEMPLATE/question.yml | Added structured question issue template |
| .github/ISSUE_TEMPLATE/feature_request.yml | Added structured feature request template |
| .github/ISSUE_TEMPLATE/config.yml | Configured issue template settings |
| .github/ISSUE_TEMPLATE/bug_report.yml | Added structured bug report template |
| .github/ISSUE_TEMPLATE.md | Removed legacy unstructured issue template |
| .github/CONTRIBUTING.md | Added comprehensive contributing guidelines and code of conduct |
| .github/CODEOWNERS | Defined code ownership for repository |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - '.github/dependabot.yml' | ||
| - '.gitignore' | ||
| - 'CHANGELOG.md' | ||
| - 'LICENSE' |
There was a problem hiding this comment.
The path-ignore pattern references 'LICENSE' but the actual file in the repository is named 'LICENSE.md'. This mismatch means changes to LICENSE.md will not be properly ignored and will trigger the CI workflow unnecessarily. The pattern should be updated to 'LICENSE.md' to match the actual filename.
| - '.github/dependabot.yml' | ||
| - '.gitignore' | ||
| - 'CHANGELOG.md' | ||
| - 'LICENSE' |
There was a problem hiding this comment.
The path-ignore pattern references 'LICENSE' but the actual file in the repository is named 'LICENSE.md'. This mismatch means changes to LICENSE.md will not be properly ignored and will trigger the CI workflow unnecessarily. The pattern should be updated to 'LICENSE.md' to match the actual filename.
| commit-message: | ||
| prefix: "build: " | ||
| - package-ecosystem: github-actions | ||
| directory: "/.github/" |
There was a problem hiding this comment.
The directory path for the github-actions package ecosystem should be "/" not "/.github/". GitHub Actions workflows are typically located in .github/workflows, but Dependabot expects the directory to be set to "/" to monitor all GitHub Actions in the repository. This incorrect path will prevent Dependabot from detecting and updating GitHub Actions dependencies.
| directory: "/.github/" | |
| directory: "/" |
| name: "Bug report" | ||
| description: "Report a reproducible bug." | ||
| title: "[Bug] {{summary}}" | ||
| type: bug |
There was a problem hiding this comment.
The type: field is not a valid top-level field in GitHub issue form syntax. GitHub issue forms only support name, description, title, labels, assignees, and body at the top level. This field should be removed as it will cause the issue template to fail validation.
| type: bug |
| name: "Question" | ||
| description: "Ask a question about how to use the project, APIs or docs." | ||
| title: "[Question] {{summary}}" | ||
| type: question |
There was a problem hiding this comment.
The type: field is not a valid top-level field in GitHub issue form syntax. GitHub issue forms only support name, description, title, labels, assignees, and body at the top level. This field should be removed as it will cause the issue template to fail validation.
| type: question |
| placeholder: "Brief summary (<=120 chars)" | ||
| validations: | ||
| required: true | ||
| max_length: 120 |
There was a problem hiding this comment.
The validation field max_length is not a valid validation option for input elements in GitHub issue forms. Input elements only support the required validation option. If you want to enforce character limits, this should be mentioned in the description or placeholder text instead, as GitHub issue forms do not provide native max length validation for input fields.
| max_length: 120 |
| placeholder: "Brief summary (<=120 chars)" | ||
| validations: | ||
| required: true | ||
| max_length: 120 |
There was a problem hiding this comment.
The validation field max_length is not a valid validation option for input elements in GitHub issue forms. Input elements only support the required validation option. If you want to enforce character limits, this should be mentioned in the description or placeholder text instead, as GitHub issue forms do not provide native max length validation for input fields.
| max_length: 120 |
| - Ensure your commit message should | ||
| follow [conventional commit message guidelines](https://www.conventionalcommits.org/en/v1.0.0/) |
There was a problem hiding this comment.
Awkward sentence structure. The phrase "Ensure your commit message should follow" contains redundant auxiliary verbs. It should be either "Ensure your commit message follows" or "Your commit message should follow" to improve clarity and grammatical correctness.
| - Ensure your commit message should | |
| follow [conventional commit message guidelines](https://www.conventionalcommits.org/en/v1.0.0/) | |
| - Ensure your commit message follows [conventional commit message guidelines](https://www.conventionalcommits.org/en/v1.0.0/) |
| @@ -0,0 +1,45 @@ | |||
| name: "Question" | |||
| description: "Ask a question about how to use the project, APIs or docs." | |||
| title: "[Question] {{summary}}" | |||
There was a problem hiding this comment.
The title field uses {{summary}} interpolation syntax, but GitHub issue forms do not support variable interpolation in the title field. The title field must be a static string. Users can edit the title after the issue is created, but you cannot programmatically insert values from form fields into it. Consider using a static title like "[Question] " and let users complete it, or remove the variable placeholder.
| title: "[Question] {{summary}}" | |
| title: "[Question]" |
| name: "Feature request" | ||
| description: "Suggest a new feature or an improvement." | ||
| title: "[Feature] {{summary}}" | ||
| type: feature |
There was a problem hiding this comment.
The type: field is not a valid top-level field in GitHub issue form syntax. GitHub issue forms only support name, description, title, labels, assignees, and body at the top level. This field should be removed as it will cause the issue template to fail validation.
| type: feature |
1 participant
Checklist