Skip to content

docs: Removing pnpm test:routes #2184

Merged
chronark merged 3 commits intounkeyed:mainfrom
harshsbhat:harshbhat/docs-pnpm-routes
Oct 4, 2024
Merged

docs: Removing pnpm test:routes #2184
chronark merged 3 commits intounkeyed:mainfrom
harshsbhat:harshbhat/docs-pnpm-routes

Conversation

@harshsbhat
Copy link
Contributor

@harshsbhat harshsbhat commented Oct 4, 2024

What does this PR do?

Fixes #2182

Removes the pnpm test:routes from the docs.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • Documentation
    • Updated the "Testing" document for clarity, particularly in the API Tests section.
    • Removed the section on routes, simplifying the content while retaining focus on integration testing.

@changeset-bot
Copy link

changeset-bot bot commented Oct 4, 2024

⚠️ No Changeset found

Latest commit: 85cbec9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
unkey-engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 4, 2024 7:02pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve modifications to the "Testing" documentation in the apps/docs/contributing/testing.mdx file. The section on API Tests has been rephrased for clarity, and the entire section on routes has been removed. This section previously included instructions for local server setup and database requirements, which have also been eliminated. The content now focuses on integration testing while retaining relevant details about end-to-end tests.

Changes

File Change Summary
apps/docs/contributing/testing.mdx Rephrased API Tests section for clarity; removed routes section and related database instructions.

Assessment against linked issues

Objective Addressed Explanation
Remove references to pnpm test:routes from the docs (2182)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vercel
Copy link

vercel bot commented Oct 4, 2024

@harshsbhat is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 4, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@github-actions github-actions bot added Documentation Improvements or additions to documentation Needs Approval Needs approval from Unkey labels Oct 4, 2024
@vercel vercel bot temporarily deployed to Preview – unkey-engineering October 4, 2024 17:32 Inactive
@vercel vercel bot temporarily deployed to Preview – unkey-engineering October 4, 2024 17:33 Inactive
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
apps/docs/contributing/testing.mdx (1)

16-16: Approved with a minor suggestion.

The simplification of the explanation for integration tests is good. However, consider adding a comma after "enough" for better readability.

Suggested change:

-`/apps/api` is our core product and needs to be heavily tested. Unit tests are not enough so we also use integration tests:
+`/apps/api` is our core product and needs to be heavily tested. Unit tests are not enough, so we also use integration tests:
🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Possible missing comma found.
Context: ...o be heavily tested. Unit tests are not enough so we also use integration tests: ### ...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 600839e and ac8ffc4.

📒 Files selected for processing (1)
  • apps/docs/contributing/testing.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/docs/contributing/testing.mdx

[uncategorized] ~16-~16: Possible missing comma found.
Context: ...o be heavily tested. Unit tests are not enough so we also use integration tests: ### ...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (2)
apps/docs/contributing/testing.mdx (2)

Line range hint 1-24: LGTM: Remaining content is consistent and clear.

The remaining content of the file, including the general testing instructions and the integration section, is consistent with the document's purpose and provides clear guidance for running tests.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Possible missing comma found.
Context: ...o be heavily tested. Unit tests are not enough so we also use integration tests: ### ...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~20-~20: Did you mean the adjective “end-to-end” (spelled with hyphens)?
Context: ...gration tests: ### integration Full end to end tests require a running API either loca...

(END_TO_END_HYPHEN)


[uncategorized] ~20-~20: Possible missing comma found.
Context: ...Full end to end tests require a running API either locally or in a deployed environ...

(AI_HYDRA_LEO_MISSING_COMMA)


16-16: Verify removal of 'routes' section.

The removal of the routes section, which included references to "pnpm test:routes", aligns with the PR objectives. However, let's verify that all references have been removed from the file.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Possible missing comma found.
Context: ...o be heavily tested. Unit tests are not enough so we also use integration tests: ### ...

(AI_HYDRA_LEO_MISSING_COMMA)

@vercel vercel bot temporarily deployed to Preview – unkey-engineering October 4, 2024 19:02 Inactive
@chronark chronark added 🕹️ oss.gg and removed Needs Approval Needs approval from Unkey labels Oct 4, 2024
@chronark chronark merged commit 5812a44 into unkeyed:main Oct 4, 2024
@oss-gg
Copy link

oss-gg bot commented Oct 4, 2024

Awarding harshsbhat: 150 points 🕹️ Well done! Check out your new contribution on oss.gg/harshsbhat

AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 5, 2024
github-merge-queue bot pushed a commit that referenced this pull request Oct 5, 2024
* feat/mobile-sidbar-sync-with-desktop

* fix(billing): add missing subscription fields and audit logging to upgrade flow (#2179)

* fix(billing): add missing subscription fields and audit logging to upgrade flow

* fix context properties

* refactor: query audit logs from planetscale (#2181)

* refactor: query audit logs from planetscale

* fix: sort logs

* [autofix.ci] apply automated fixes

* chore: remove csv export

* Update apps/dashboard/app/(app)/audit/[bucket]/page.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fmt: add comma

* ci: remove wrong lint command

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* chore: Unkey PDF Viewer template [SIDE QUEST] (#2191)

* chore: Unkey PDF Viewer template

* feat: add template

---------

Co-authored-by: chronark <[email protected]>

* perf: add database indices (#2192)

* fix: add header again

* docs: Removing pnpm test:routes (#2184)

* fix: revalidate /apis after creating new API (#2183)

* fix: revalidate /apis after creating new API key

* fix: show success message after revalidate suceeds

* fix: revalidate cache before routing

* chore(deps-dev): bump @types/react-dom from 18.2.25 to 18.3.0 (#2187)

Bumps [@types/react-dom](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-dom) from 18.2.25 to 18.3.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-dom)

---
updated-dependencies:
- dependency-name: "@types/react-dom"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Refactor/workspace-navigation

* ran fmt

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Meg Stepp <[email protected]>
Co-authored-by: Andreas Thomas <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nazar Poshtarenko <[email protected]>
Co-authored-by: Harsh Shrikant Bhat <[email protected]>
Co-authored-by: Gerald Maboshe <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
harshsbhat added a commit to harshsbhat/unkey that referenced this pull request Oct 5, 2024
* feat/mobile-sidbar-sync-with-desktop

* fix(billing): add missing subscription fields and audit logging to upgrade flow (unkeyed#2179)

* fix(billing): add missing subscription fields and audit logging to upgrade flow

* fix context properties

* refactor: query audit logs from planetscale (unkeyed#2181)

* refactor: query audit logs from planetscale

* fix: sort logs

* [autofix.ci] apply automated fixes

* chore: remove csv export

* Update apps/dashboard/app/(app)/audit/[bucket]/page.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fmt: add comma

* ci: remove wrong lint command

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* chore: Unkey PDF Viewer template [SIDE QUEST] (unkeyed#2191)

* chore: Unkey PDF Viewer template

* feat: add template

---------

Co-authored-by: chronark <[email protected]>

* perf: add database indices (unkeyed#2192)

* fix: add header again

* docs: Removing pnpm test:routes (unkeyed#2184)

* fix: revalidate /apis after creating new API (unkeyed#2183)

* fix: revalidate /apis after creating new API key

* fix: show success message after revalidate suceeds

* fix: revalidate cache before routing

* chore(deps-dev): bump @types/react-dom from 18.2.25 to 18.3.0 (unkeyed#2187)

Bumps [@types/react-dom](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-dom) from 18.2.25 to 18.3.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-dom)

---
updated-dependencies:
- dependency-name: "@types/react-dom"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Refactor/workspace-navigation

* ran fmt

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Meg Stepp <[email protected]>
Co-authored-by: Andreas Thomas <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nazar Poshtarenko <[email protected]>
Co-authored-by: Harsh Shrikant Bhat <[email protected]>
Co-authored-by: Gerald Maboshe <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
github-merge-queue bot pushed a commit that referenced this pull request Oct 5, 2024
* Add default bytes and prefix

* adding bytes and prefix columns in harness

* fmt

* Await

* Resolved changes

* typo

* Capital and Extra bracket

* [autofix.ci] apply automated fixes

* feat: mobile-sidbar-sync-with-desktop (#2180)

* feat/mobile-sidbar-sync-with-desktop

* fix(billing): add missing subscription fields and audit logging to upgrade flow (#2179)

* fix(billing): add missing subscription fields and audit logging to upgrade flow

* fix context properties

* refactor: query audit logs from planetscale (#2181)

* refactor: query audit logs from planetscale

* fix: sort logs

* [autofix.ci] apply automated fixes

* chore: remove csv export

* Update apps/dashboard/app/(app)/audit/[bucket]/page.tsx

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fmt: add comma

* ci: remove wrong lint command

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* chore: Unkey PDF Viewer template [SIDE QUEST] (#2191)

* chore: Unkey PDF Viewer template

* feat: add template

---------

Co-authored-by: chronark <[email protected]>

* perf: add database indices (#2192)

* fix: add header again

* docs: Removing pnpm test:routes (#2184)

* fix: revalidate /apis after creating new API (#2183)

* fix: revalidate /apis after creating new API key

* fix: show success message after revalidate suceeds

* fix: revalidate cache before routing

* chore(deps-dev): bump @types/react-dom from 18.2.25 to 18.3.0 (#2187)

Bumps [@types/react-dom](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-dom) from 18.2.25 to 18.3.0.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-dom)

---
updated-dependencies:
- dependency-name: "@types/react-dom"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Refactor/workspace-navigation

* ran fmt

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Meg Stepp <[email protected]>
Co-authored-by: Andreas Thomas <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nazar Poshtarenko <[email protected]>
Co-authored-by: Harsh Shrikant Bhat <[email protected]>
Co-authored-by: Gerald Maboshe <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: update go sdk code examples to the current sdk version (#2200)

* fix: update go sdk code examples to the current sdk version

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Andreas Thomas <[email protected]>

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Akshay <[email protected]>
Co-authored-by: Meg Stepp <[email protected]>
Co-authored-by: Andreas Thomas <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nazar Poshtarenko <[email protected]>
Co-authored-by: Gerald Maboshe <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] pnpm test:routes has been removed but it is not updated in the docs

2 participants