-
-
Notifications
You must be signed in to change notification settings - Fork 115
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(api): add event #115
feat(api): add event #115
Conversation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 00fe247. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 5 targetsSent with 💌 from NxCloud. |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #115 +/- ##
============================================
+ Coverage 31.22% 52.97% +21.74%
============================================
Files 54 78 +24
Lines 1156 1531 +375
Branches 210 268 +58
============================================
+ Hits 361 811 +450
+ Misses 795 720 -75
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
PR Description updated to latest commit (a7e19dd) |
PR Analysis(review updated until commit b9a005a)
PR Feedback💡 General suggestions: The PR is well-structured and the code changes are logically organized. However, it would be beneficial to add error handling for the 🤖 Code feedback:
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
/review |
Persistent review updated to latest commit b9a005a |
Quality Gate passedIssues Measures |
## [1.1.0](v1.0.0...v1.1.0) (2024-02-12) ### 🚀 Features * **api:** add event ([#115](#115)) ([19e6603](19e6603)) ### 🔧 Miscellaneous Chores * **ci:** CI rework ([788c141](788c141)) * **ci:** update CI of web and API ([bd171da](bd171da)) * **husky:** Update precommit ([b170cf3](b170cf3)) * migrate from supabase to postgresql ([#129](#129)) ([e1ff912](e1ff912)) * update CI ([32eb820](32eb820)) * Update release config in package.json ([71c75a7](71c75a7)) * **version:** Upgrade next from 14.0.4 to 14.1.0 ([#136](#136)) ([c958865](c958865)) * **version:** Upgrade reflect-metadata from 0.1.14 to 0.2.1 ([#137](#137)) ([574b6ce](574b6ce))
🎉 This PR is included in version 1.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
User description
Features added
Event types
Events will be created on the following actions:
Services and controllers
Type
Enhancement
Description
This PR adds event creation for various operations in the API. It introduces a new
createEvent
function in thecommon
directory, which is used to create events for different types of operations. The following files have been modified:api-key.service.ts
: Added event creation for API key operations.app.module.ts
: AddedEventModule
to the app module.create-event.ts
: AddedcreateEvent
function for creating events.get-secret-with-authority.ts
: AddedgetSecretWithAuthority
function for retrieving secrets with authority.environment.service.ts
: Added event creation for environment operations.event.controller.spec.ts
: Added unit test forEventController
.event.controller.ts
: Added endpoint for getting events.event.module.ts
: AddedEventModule
.event.service.spec.ts
: Added unit test forEventService
.event.service.ts
: Added event creation for event operations.project.service.ts
: Added event creation for project operations.secret.service.ts
: Added event creation for secret operations.user.service.ts
: Added event creation for user operations.workspace-role.service.ts
: Added event creation for workspace role operations.workspace.service.ts
: Added event creation for workspace operations.Changes walkthrough
15 files
api-key.service.ts
Add event creation for API key operations
apps/api/src/api-key/service/api-key.service.ts
Added event creation for API key operations
app.module.ts
Add EventModule to app module
apps/api/src/app/app.module.ts
Added EventModule to app module
create-event.ts
Add createEvent function for creating events
apps/api/src/common/create-event.ts
Added createEvent function for creating events
get-secret-with-authority.ts
Add getSecretWithAuthority function for retrieving secrets with
authority
apps/api/src/common/get-secret-with-authority.ts
Added getSecretWithAuthority function for retrieving secrets with
authority
environment.service.ts
Add event creation for environment operations
apps/api/src/environment/service/environment.service.ts
Added event creation for environment operations
event.controller.spec.ts
Add unit test for EventController
apps/api/src/event/controller/event.controller.spec.ts
Added unit test for EventController
event.controller.ts
Add endpoint for getting events
apps/api/src/event/controller/event.controller.ts
Added endpoint for getting events
event.module.ts
Add EventModule
apps/api/src/event/event.module.ts
Added EventModule
event.service.spec.ts
Add unit test for EventService
apps/api/src/event/service/event.service.spec.ts
Added unit test for EventService
event.service.ts
Add event creation for event operations
apps/api/src/event/service/event.service.ts
Added event creation for event operations
project.service.ts
Add event creation for project operations
apps/api/src/project/service/project.service.ts
Added event creation for project operations
secret.service.ts
Add event creation for secret operations
apps/api/src/secret/service/secret.service.ts
Added event creation for secret operations
user.service.ts
Add event creation for user operations
apps/api/src/user/service/user.service.ts
Added event creation for user operations
workspace-role.service.ts
Add event creation for workspace role operations
apps/api/src/workspace-role/service/workspace-role.service.ts
Added event creation for workspace role operations
workspace.service.ts
Add event creation for workspace operations
apps/api/src/workspace/service/workspace.service.ts
Added event creation for workspace operations
✨ Usage guide:
Overview:
The
describe
tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_description
section), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describe
tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_name
is one of the following:type
: the PR type.summary
: the PR summary.walkthrough
: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describe
tool are quite generic: [Bug fix
,Tests
,Enhancement
,Documentation
,Other
].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance
- pr_agent:The main topic of this PR is performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Inline File Walkthrough 💎
For enhanced user experience, the
describe
tool can add file summaries directly to the "Files changed" tab in the PR page.This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).
To enable inline file summary, set
pr_description.inline_file_summary
in the configuration file, possible values are:'table'
: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.true
: A collapsable file comment with changes title and a changes summary for each file in the PR.false
(default): File changes walkthrough will be added only to the "Conversation" tab.Utilizing extra instructions
The
describe
tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.