docs: Add instructions for resetting the local Prisma database (#495) #501

Aleesssino · 2024-10-16T23:58:42Z

User description

Description

Added a command pnpm run db:reset to the documentation for resetting the local Prisma database. This helps contributors start fresh when testing locally or troubleshooting. The change is included in the "Running the API" section.

Fixes #495

Developer's checklist

My PR follows the style guidelines of this project
I have performed a self-check on my work

If changes are made in the code:

I have followed the coding guidelines
My changes in code generate no new warnings
My changes are breaking another fix/feature of the project
I have added test cases to show that my feature works
I have added relevant screenshots in my PR
There are no UI/UX issues

Documentation Update

This PR requires an update to the documentation at docs.keyshade.xyz
I have made the necessary updates to the documentation, or no documentation changes are required.

PR Type

Documentation

Description

Added documentation on how to reset the local Prisma database using the command pnpm run db:reset.
This addition helps contributors start with a clean database state for testing and troubleshooting.
The new instructions are included in the "Running the API" section of the documentation.

Changes walkthrough 📝

Relevant files

Documentation

running-the-api.md `Add database reset instructions to API running guide` docs/contributing-to-keyshade/running-things-locally/running-the-api.md Added instructions for resetting the local Prisma database. Introduced a new command `pnpm run db:reset`.	+6/-0

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

…ade-xyz#495)

codiumai-pr-agent-free · 2024-10-16T23:58:57Z

PR Reviewer Guide 🔍

(Review updated until commit `f92859a`)

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 495 - Fully compliant Fully compliant requirements: Add documentation on how to reset the local Prisma database Include clear steps for resetting the database in the "Running the API" section Help contributors start with a clean slate for testing and troubleshooting
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

codiumai-pr-agent-free · 2024-10-16T23:59:01Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category Suggestion Score

Enhancement

✅ Provide context for when and why to use the database reset command

Suggestion Impact:

The commit added context to the database reset command by explaining a scenario when it might be used, aligning with the suggestion to provide context.

code diff:

-- Whenever you need to reset the database, use this command:
+- There might be a case when you would like to create a completely fresh copy of the database. In that case, you might use the reset command:

Consider adding a brief explanation of when and why a developer might need to reset
the database. This context can help contributors understand the appropriate use of
this command.

docs/contributing-to-keyshade/running-things-locally/running-the-api.md [27-31]

-- Whenever you need to reset the database, use this command:
+- To reset the database (e.g., after schema changes or for a clean slate), use this command:
 
 ```bash
 pnpm run db:reset

+This command will clear all data and apply the latest migrations.
+


- [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 -->

<details><summary>Suggestion importance[1-10]: 5</summary>

Why: The suggestion adds valuable context for developers on when and why to use the database reset command, enhancing the documentation's clarity. However, it is not critical to the functionality, hence a moderate score.


</details></details></td><td align=center>5

</td></tr></tr></tbody></table>

>💡 Need additional feedback ? start a [PR chat](https://chromewebstore.google.com/detail/ephlnjeghhogofkifjloamocljapahnl)

codiumai-pr-agent-free · 2024-10-17T14:34:34Z

Persistent review updated to latest commit f92859a

codiumai-pr-agent-free · 2024-10-17T14:34:46Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category Suggestion Score

Enhancement

✅ Provide context for when and why to use the database reset command

Suggestion Impact:

The commit added context to the database reset command, explaining when it might be used, which aligns with the suggestion to provide context.

code diff:

-- Whenever you need to reset the database, use this command:
+- There might be a case when you would like to create a completely fresh copy of the database. In that case, you might use the reset command:

Consider adding a brief explanation of when and why a developer might need to reset
the database. This context can help contributors understand the appropriate use of
this command.

docs/contributing-to-keyshade/running-things-locally/running-the-api.md [27-31]

-- Whenever you need to reset the database, use this command:
+- To reset the database (e.g., after schema changes or for a clean slate), use this command:
 
 ```bash
 pnpm run db:reset

+This command will clear all data and apply the latest migrations.
+


- [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 -->

<details><summary>Suggestion importance[1-10]: 5</summary>

Why: The suggestion adds valuable context for developers on when and why to use the database reset command, enhancing the documentation's clarity. However, it is not critical to the functionality, hence a moderate score.


</details></details></td><td align=center>5

</td></tr></tr></tbody></table>

>💡 Need additional feedback ? start a [PR chat](https://chromewebstore.google.com/detail/ephlnjeghhogofkifjloamocljapahnl)

rajdip-b · 2024-10-17T14:55:10Z

@Aleesssino hey mate, don't include the [] when you tag the issue in the description. It doesn't really tag the issue that way!

docs/contributing-to-keyshade/running-things-locally/running-the-api.md

…yshade-xyz#501)

Aleesssino · 2024-10-17T15:32:21Z

@Aleesssino hey mate, don't include the [] when you tag the issue in the description. It doesn't really tag the issue that way!

Hey, I appreciate the heads-up! I actually caught it and fixed it earlier—just didn't notice it at first since I was in a bit of a rush. Thanks for looking out though!

## [2.6.0](v2.5.0...v2.6.0) (2024-10-24) ### 🚀 Features * **api:** Add icon and remove description field from workspace ([#435](#435)) ([a99c0db](a99c0db)) * **api-client:** Added workspace-membership and related tests ([#452](#452)) ([6a1c091](6a1c091)) * **api-client:** Create controller for User module ([#484](#484)) ([f9d8e83](f9d8e83)) * **api:** Add prod env schema in env file ([#436](#436)) ([21c3004](21c3004)) * **api:** Add resend otp implementation ([#445](#445)) ([4dc6aa1](4dc6aa1)) * **api:** Fetch total count of environments, [secure]s and variables in project ([#434](#434)) ([0c9e50a](0c9e50a)) * **api:** Replace `projectId` with `name` and `slug` in workspace-role response. ([#432](#432)) ([af06071](af06071)) * **cli:** Add functionality to operate on Secrets ([#504](#504)) ([1b4bf2f](1b4bf2f)) * **cli:** Add project command ([#451](#451)) ([70448e1](70448e1)) * **cli:** Add workspace operations ([#441](#441)) ([ed38d22](ed38d22)) * **cli:** implement commands to get, list, update, and delete, workspace roles ([#469](#469)) ([957ea8d](957ea8d)) * **cli:** Implemented pagination support ([#453](#453)) ([feb1806](feb1806)) * **cli:** Secret scan ([#438](#438)) ([85cb8ab](85cb8ab)) * **cli:** Update environment command outputs ([f4af874](f4af874)) * **platform:** Clearing email field after waitlisting the user email ([#481](#481)) ([256d659](256d659)) * Remove project IDs from workspace role export data and update tests ([#448](#448)) ([8fdb328](8fdb328)) * **web:** Configured extra check for waitlisted users already in the list and created toast message for them ([#492](#492)) ([2ddd0ef](2ddd0ef)) * **web:** show the toast only when email add successfully ([#490](#490)) ([783c411](783c411)) ### 🐛 Bug Fixes * **api,api-client:** Add environmentSlug in multiple places across the variable module ([#468](#468)) ([d970aff](d970aff)) * **api:** Replace the id with slug in the global-search service ([#455](#455)) ([74804b1](74804b1)) * **platform:** Fixed duplicate Google Logo UI fix ([#450](#450)) ([fb0d6f7](fb0d6f7)) * resolve footer website name cut-off or overlap issue ([#444](#444)) ([fe03ba2](fe03ba2)) * **web:** Horizontal Scrolling issue on the website ([#440](#440)) ([655177b](655177b)) ### 📚 Documentation * Add documentation for environment in CLI ([#462](#462)) ([dad7394](dad7394)) * Add documentation for project in CLI ([#466](#466)) ([341fb32](341fb32)) * Add documentation for scan in CLI ([#461](#461)) ([72281e6](72281e6)) * Add documentation for workspace command ([#464](#464)) ([4aad8a2](4aad8a2)) * Add instructions for resetting the local Prisma database ([#495](#495)) ([#501](#501)) ([b07ea17](b07ea17)) * Added docker support documentation ([#465](#465)) ([bc04be4](bc04be4)) * Added documentation for running the platform ([#473](#473)) ([8b8386b](8b8386b)) * Added missing mappings to pages ([5de9fd8](5de9fd8)) * Fix Documentation Hyperlink and update expired Discord invite link ([#496](#496)) ([5a10e39](5a10e39)) * Updated CLI docs ([#460](#460)) ([c7e0f13](c7e0f13)) ### 🔧 Miscellaneous Chores * Add more logging to Sentry init ([#470](#470)) ([de4925d](de4925d)) * **api:** Optimise API docker image size ([#360](#360)) ([ea40dc1](ea40dc1)) * **api:** Updated lockfile ([a968e78](a968e78)) * **CI:** Add [secure] scan validation ([f441262](f441262)) * **cli:** Update controller invocation in environment commands ([#477](#477)) ([596bd1a](596bd1a)) * Minor changes to variables ([fe01ca6](fe01ca6)) * **[secure]-scan:** Failing lint issues ([#507](#507)) ([48f45df](48f45df)) * **[secure]-scan:** Formatted files ([5884833](5884833)) * Update .env.example ([70ad4f7](70ad4f7)) * Updated scripts ([9eb76a7](9eb76a7)) * **web:** email validation ([#487](#487)) ([e8e737a](e8e737a))

rajdip-b · 2024-10-24T12:11:19Z

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

docs: Add instructions for resetting the local Prisma database (keysh…

43bb995

…ade-xyz#495)

codiumai-pr-agent-free bot added Documentation Review effort [1-5]: 1 labels Oct 16, 2024

Aleesssino marked this pull request as draft October 17, 2024 09:51

Merge branch 'develop' into develop

f92859a

Aleesssino marked this pull request as ready for review October 17, 2024 14:34

rajdip-b requested changes Oct 17, 2024

View reviewed changes

docs/contributing-to-keyshade/running-things-locally/running-the-api.md Outdated Show resolved Hide resolved

Aleesssino and others added 2 commits October 17, 2024 17:30

docs: Update instructions for resetting the local Prisma database (ke…

ce49a6b

…yshade-xyz#501)

Merge branch 'develop' into develop

17d9d5e

Aleesssino requested a review from rajdip-b October 18, 2024 01:54

rajdip-b approved these changes Oct 18, 2024

View reviewed changes

rajdip-b merged commit b07ea17 into keyshade-xyz:develop Oct 18, 2024
5 checks passed

rajdip-b added the released label Oct 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Add instructions for resetting the local Prisma database (#495) #501

docs: Add instructions for resetting the local Prisma database (#495) #501

Aleesssino commented Oct 16, 2024 •

edited by rajdip-b

Loading

codiumai-pr-agent-free bot commented Oct 16, 2024 •

edited

Loading

codiumai-pr-agent-free bot commented Oct 16, 2024 •

edited

Loading

codiumai-pr-agent-free bot commented Oct 17, 2024

codiumai-pr-agent-free bot commented Oct 17, 2024 •

edited

Loading

rajdip-b commented Oct 17, 2024

Aleesssino commented Oct 17, 2024

rajdip-b commented Oct 24, 2024

docs: Add instructions for resetting the local Prisma database (#495) #501

docs: Add instructions for resetting the local Prisma database (#495) #501

Conversation

Aleesssino commented Oct 16, 2024 • edited by rajdip-b Loading

User description

Description

Developer's checklist

Documentation Update

PR Type

Description

Changes walkthrough 📝

codiumai-pr-agent-free bot commented Oct 16, 2024 • edited Loading

PR Reviewer Guide 🔍

(Review updated until commit f92859a)

codiumai-pr-agent-free bot commented Oct 16, 2024 • edited Loading

PR Code Suggestions ✨

codiumai-pr-agent-free bot commented Oct 17, 2024

codiumai-pr-agent-free bot commented Oct 17, 2024 • edited Loading

PR Code Suggestions ✨

rajdip-b commented Oct 17, 2024

Aleesssino commented Oct 17, 2024

rajdip-b commented Oct 24, 2024

Aleesssino commented Oct 16, 2024 •

edited by rajdip-b

Loading

codiumai-pr-agent-free bot commented Oct 16, 2024 •

edited

Loading

(Review updated until commit `f92859a`)

codiumai-pr-agent-free bot commented Oct 16, 2024 •

edited

Loading

codiumai-pr-agent-free bot commented Oct 17, 2024 •

edited

Loading