Skip to content
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

chore: FoalTS middleware with Unkey RBAC #2537

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

harshsbhat
Copy link
Contributor

@harshsbhat harshsbhat commented Oct 22, 2024

Adds a template that showcases an RBAC middleware for API key authentication in a FoalTS backend, using Unkey API for secure key management.

https://github.com/harshsbhat/unkey-foal

Fixes #2150

Summary by CodeRabbit

  • New Features

    • Added a new project entry showcasing "FoalTS middleware with Unkey RBAC," including a link to the GitHub repository.
  • Documentation

    • Updated project list to reflect the new addition while maintaining existing submission guidelines.

Copy link

changeset-bot bot commented Oct 22, 2024

⚠️ No Changeset found

Latest commit: 06fb40a

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

Copy link

vercel bot commented Oct 22, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces a new entry to a project list that demonstrates the use of Unkey with various frameworks for building APIs. Specifically, it adds a project titled "FoalTS middleware with Unkey RBAC," created by Harsh Bhat on 22-October-2024, along with a link to the GitHub repository. The existing structure and requirements for submissions remain unchanged, maintaining the emphasis on open-source projects that are MIT licensed and include a README.md with a quickstart guide.

Changes

File Change Summary
oss.gg/7_create_a_template.md Added a new entry for "FoalTS middleware with Unkey RBAC" by Harsh Bhat, including a GitHub link.

Assessment against linked issues

Objective Addressed Explanation
Add new project entries for hackathon submissions
Maintain structure and requirements for submissions

Possibly related PRs

Suggested labels

:joystick: 750 points

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dd982ca and 06fb40a.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • oss.gg/7_create_a_template.md

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.

Copy link
Contributor

github-actions bot commented Oct 22, 2024

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

Copy link

vercel bot commented Oct 22, 2024

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

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 11:10am

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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b456ac0 and dd982ca.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🧰 Additional context used

@@ -54,4 +54,6 @@ Your turn 👇

» 12-October-2024 by Nazar Poshtarenko [Next.js Unkey Pay-as-you-Go Starter Kit](https://github.com/unrenamed/unkey-nextjs-pay-as-you-go)

» 22-October-2024 by Nazar Poshtarenko [FoalTS middleware with Unkey RBAC](https://github.com/harshsbhat/unkey-foal)
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Attribution needs correction - repository owner is the sole contributor

Based on the repository data and commit history:

  • Repository owner: Harsh Shrikant Bhat (harshsbhat)
  • All commits are from Harsh Shrikant Bhat
  • No contributions or mentions of Nazar Poshtarenko

The template entry should be updated to correctly attribute the work to Harsh Shrikant Bhat instead of Nazar Poshtarenko.

🔗 Analysis chain

Verify authorship of the template

There appears to be an inconsistency between the claimed author (Nazar Poshtarenko) and the repository owner (harshsbhat). Please clarify the correct attribution or update the repository link if this is a collaborative work.


Let me try a different approach to verify the repository details and contributors.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify repository ownership and contributors

# Test: Check repository details and contributors
gh repo view harshsbhat/unkey-foal --json owner,name,description,collaborators

Length of output: 1211


Script:

#!/bin/bash
# Description: Verify repository ownership and contributors using different fields

# Get basic repository info
gh repo view harshsbhat/unkey-foal --json owner,name,description,mentionableUsers

# Also check recent commits to see contribution patterns
gh api /repos/harshsbhat/unkey-foal/commits --paginate | jq -r '.[].commit.author'

Length of output: 1141

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[🕹️] SIDE QUESTS: https://go.unkey.com/ossgg-challenges
1 participant