Dev #58
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # [1.17.0-dev.27](https://github.com/codebridger/lib-vue-components/compare/dev-1.17.0-dev.26...dev-1.17.0-dev.27) (2025-07-19) | ||
|
|
||
| # [1.17.0-dev.26](https://github.com/codebridger/lib-vue-components/compare/dev-1.17.0-dev.25...dev-1.17.0-dev.26) (2025-07-19) | ||
|
|
||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * correct parameter name in PR description workflow from system_prompt to user_prompt ([97f4d24](https://github.com/codebridger/lib-vue-components/commit/97f4d2480736d0aeb9caacb4cef66888d4b4af7d)) | ||
|
|
||
| # [1.17.0-dev.25](https://github.com/codebridger/lib-vue-components/compare/dev-1.17.0-dev.24...dev-1.17.0-dev.25) (2025-07-19) | ||
|
|
||
|
|
||
| ### Bug Fixes | ||
|
|
||
| * update PR description workflow to properly format content by replacing newlines with escaped characters ([4a48764](https://github.com/codebridger/lib-vue-components/commit/4a48764e00c5f81a43a2b98c53016731492f4fb5)) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Pull Request Description | ||
|
|
||
| > **Note**: Not all sections are required for every PR. Use only the sections that are relevant to your changes. Focus on the most important information for your specific pull request. | ||
|
|
||
| ## 📋 Overview & Changes | ||
| <!-- Provide a brief summary of what this PR accomplishes and key changes --> | ||
|
|
||
| ### 🎯 What was implemented | ||
| - [ ] Feature A | ||
| - [ ] Feature B | ||
| - [ ] Bug fix for issue C | ||
|
|
||
| ### 📝 Commit Summary | ||
|
There was a problem hiding this comment. 🟡 OPTIONAL: The Commit Summary section is generic. To improve usefulness, consider adding more guidance or examples on how to extract key insights from commit messages or code changes for this section. |
||
| <!-- | ||
| Summary generated from commit messages and code changes: | ||
| - Key features implemented | ||
| - Bug fixes applied | ||
| - Files modified | ||
| - Breaking changes | ||
| - Performance improvements | ||
| - Code refactoring | ||
| --> | ||
|
|
||
| ### 🔧 Technical Details | ||
| <!-- Provide technical implementation details if relevant --> | ||
|
|
||
| ## 🔗 Related Tasks & Commit Analysis | ||
| <!-- Task tracking and commit analysis section --> | ||
|
|
||
| ### 🔍 Task IDs & Links from Commits | ||
| <!-- | ||
| Task IDs extracted from commit messages and their ClickUp links: | ||
| - Format: #task-id or CU-task-id | ||
| - ClickUp Link: https://app.clickup.com/t/[task-id] | ||
| - Example: #12345 → https://app.clickup.com/t/12345 | ||
| --> | ||
|
|
||
| ## 🧪 Testing | ||
| <!-- Describe how the changes were tested --> | ||
|
|
||
| - [ ] Unit tests added/updated | ||
| - [ ] Integration tests added/updated | ||
| - [ ] Manual testing completed | ||
| - [ ] Cross-browser testing (if applicable) | ||
|
|
||
| ## 🔍 Review Checklist | ||
| <!-- Use this checklist to ensure your PR is ready for review --> | ||
|
|
||
| ### Code Quality | ||
| - [ ] Code follows project coding standards | ||
| - [ ] No console.log statements left in production code | ||
| - [ ] No hardcoded values that should be configurable | ||
| - [ ] Proper error handling implemented | ||
| - [ ] Code is properly documented | ||
|
|
||
| ### Performance | ||
| - [ ] No performance regressions introduced | ||
|
|
||
| ### Security | ||
| - [ ] No security vulnerabilities introduced | ||
| - [ ] Input validation implemented where necessary | ||
| - [ ] Sensitive data properly handled | ||
|
|
||
| ### Accessibility | ||
| - [ ] WCAG guidelines followed | ||
| - [ ] Keyboard navigation works properly | ||
| - [ ] Screen reader compatibility tested | ||
|
|
||
| ## 🚀 Deployment Notes | ||
| <!-- Any special considerations for deployment --> | ||
|
|
||
| ## 📚 Documentation | ||
| <!-- Update any relevant documentation --> | ||
|
|
||
| - [ ] README updated (if applicable) | ||
| - [ ] API documentation updated (if applicable) | ||
| - [ ] Component documentation updated (if applicable) | ||
|
|
||
| ## 🔄 Breaking Changes | ||
| <!-- List any breaking changes that might affect other parts of the system --> | ||
|
|
||
| ## 📋 Additional Notes | ||
| <!-- Any other information that reviewers should know --> | ||
|
|
||
| --- | ||
|
|
||
| **Template Version**: 1 | ||
| **Last Updated**: 19 Jun 2025 | ||
| **Summary Source**: Commit messages and code changes | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| Take all below stracture to write a proper PR description | ||
|
|
||
| # Pull Request Description | ||
|
|
||
| > **Note**: Not all sections are required for every PR. Use only the sections that are relevant to your changes. Focus on the most important information for your specific pull request. | ||
| > | ||
| > **Required Sections**: The "🔗 Related Tasks & Commit Analysis" and "📝 Commit Summary" sections are mandatory for all PRs as they provide essential context for reviewers. | ||
|
|
||
| ## 📋 Overview & Changes | ||
| <!-- Provide a brief summary of what this PR accomplishes and key changes --> | ||
|
|
||
| ### 🎯 What was implemented | ||
| - [ ] Feature A | ||
| - [ ] Feature B | ||
| - [ ] Bug fix for issue C | ||
|
|
||
| ### 📝 Commit Summary | ||
| <!-- | ||
| Summary generated from commit messages and code changes: | ||
| - Key features implemented | ||
| - Bug fixes applied | ||
| - Files modified | ||
| - Breaking changes | ||
| - Performance improvements | ||
| - Code refactoring | ||
| --> | ||
|
|
||
| ### 🔧 Technical Details | ||
| <!-- Provide technical implementation details if relevant --> | ||
|
|
||
| ## 🔗 Related Tasks & Commit Analysis | ||
| <!-- Task tracking and commit analysis section --> | ||
|
|
||
| ### 🔍 Task IDs & Links from Commits | ||
| <!-- | ||
| Task IDs extracted from commit messages and their ClickUp links: | ||
| - Format: #task-id or CU-task-id | ||
| - ClickUp Link: https://app.clickup.com/t/[task-id] | ||
| - Example: #12345 → https://app.clickup.com/t/12345 | ||
| --> | ||
|
|
||
| ## 🧪 Testing | ||
| <!-- Describe how the changes were tested --> | ||
|
|
||
| - [ ] Unit tests added/updated | ||
| - [ ] Integration tests added/updated | ||
| - [ ] Manual testing completed | ||
| - [ ] Cross-browser testing (if applicable) | ||
|
|
||
| ## 🔍 Review Checklist | ||
| <!-- Use this checklist to ensure your PR is ready for review --> | ||
|
|
||
| ### Code Quality | ||
| - [ ] Code follows project coding standards | ||
| - [ ] No console.log statements left in production code | ||
| - [ ] No hardcoded values that should be configurable | ||
| - [ ] Proper error handling implemented | ||
| - [ ] Code is properly documented | ||
|
|
||
| ### Performance | ||
| - [ ] No performance regressions introduced | ||
|
|
||
| ### Security | ||
| - [ ] No security vulnerabilities introduced | ||
| - [ ] Input validation implemented where necessary | ||
| - [ ] Sensitive data properly handled | ||
|
|
||
| ### Accessibility | ||
| - [ ] WCAG guidelines followed | ||
| - [ ] Keyboard navigation works properly | ||
| - [ ] Screen reader compatibility tested | ||
|
|
||
| ## 🚀 Deployment Notes | ||
| <!-- Any special considerations for deployment --> | ||
|
|
||
| ## 📚 Documentation | ||
| <!-- Update any relevant documentation --> | ||
|
|
||
| - [ ] README updated (if applicable) | ||
| - [ ] API documentation updated (if applicable) | ||
| - [ ] Component documentation updated (if applicable) | ||
|
|
||
| ## 🔄 Breaking Changes | ||
| <!-- List any breaking changes that might affect other parts of the system --> | ||
|
|
||
| ## 📋 Additional Notes | ||
| <!-- Any other information that reviewers should know --> | ||
|
|
||
| --- | ||
|
|
||
| **Template Version**: 1 | ||
| **Last Updated**: 19 Jun 2025 | ||
| **Summary Source**: Commit messages and code changes |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # # https://github.com/marketplace/actions/codepress-review | ||
| # # How to use: | ||
| # # 1. Add the following to your PR description: | ||
| # # @codepress/review | ||
|
|
||
| # name: CodePress Review | ||
|
|
||
| # on: | ||
| # pull_request_target: | ||
| # types: [] | ||
| # issue_comment: | ||
| # types: [created] | ||
| # workflow_dispatch: # Allows manual triggering from the Actions tab | ||
|
|
||
| # permissions: | ||
| # pull-requests: write | ||
| # contents: read | ||
| # issues: read # Required to read PR comments | ||
|
|
||
| # jobs: | ||
| # ai-review: | ||
| # runs-on: ubuntu-latest | ||
| # steps: | ||
| # - name: Checkout code | ||
| # uses: actions/checkout@v4 | ||
| # with: | ||
| # fetch-depth: 0 | ||
| # ref: ${{ github.event.issue.pull_request && format('refs/pull/{0}/head', github.event.issue.number) || github.ref }} | ||
|
|
||
| # - name: CodePress Review | ||
| # uses: quantfive/codepress-review@v2 | ||
| # with: | ||
| # github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| # model_provider: "openai" | ||
| # model_name: "gpt-4.1-mini-2025-04-14" | ||
| # openai_api_key: ${{ secrets.OPENAI_API_KEY_FOR_PR_DESC_GENERATOR }} | ||
| # # Comment triggers are enabled by default | ||
| # run_on_comment_trigger: false # Disable comment triggers | ||
| # # comment_trigger_phrase: "@codepress/review" # Default |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| name: Generate PR Description | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, edited, synchronize] | ||
|
|
||
| env: | ||
| TEMPLATE_FILE_PATH: .github/pr-description-template.md | ||
|
|
||
| jobs: | ||
| generate-description: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 2 | ||
|
|
||
| - name: Read template content | ||
| id: read-template | ||
| run: | | ||
| content=$(cat ${{ env.TEMPLATE_FILE_PATH }} | sed ':a;N;$!ba;s/\n/\\n/g') | ||
| echo "template_content=$content" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Get Git Diff | ||
| id: git_diff | ||
| run: | | ||
| DIFF=$(git diff HEAD^ HEAD) | ||
| echo "diff=$(echo "$DIFF" | jq -sRr @uri)" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Generate PR Description | ||
|
There was a problem hiding this comment. 🟡 OPTIONAL: Consider adding comments in the workflow YAML to briefly explain the purpose of the steps for future maintainers. This can improve clarity about the use of the OpenAI API key and the custom prompt. |
||
| id: generate_desc | ||
| uses: alvarocperez/pull-request-description@v1.0.2 | ||
| with: | ||
| api_key: ${{ secrets.OPENAI_API_KEY_FOR_PR_DESC_GENERATOR }} | ||
| prompt: ${{ steps.read-template.outputs.template_content }} | ||
| git_diff: ${{ steps.git_diff.outputs.diff }} | ||
|
|
||
| - name: Update PR Description | ||
| uses: actions/github-script@v6 | ||
| env: | ||
| PR_DESCRIPTION: ${{ steps.generate_desc.outputs.description }} | ||
| with: | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| script: | | ||
| const { owner, repo } = context.repo; | ||
| await github.rest.pulls.update({ | ||
| owner, | ||
| repo, | ||
| pull_number: context.payload.pull_request.number, | ||
| body: process.env.PR_DESCRIPTION | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👏 PRAISE: This is a well-structured and comprehensive PR template that covers key aspects such as overview, testing, review checklist, and documentation. It will help contributors provide high-quality PR descriptions, improving collaboration and review efficiency.