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: Unkey + Feathers template [SIDE QUEST] #2376

Merged
merged 2 commits into from
Oct 28, 2024

Conversation

unrenamed
Copy link
Contributor

@unrenamed unrenamed commented Oct 13, 2024

What does this PR do?

Adds an Unkey template showcasing how to protect your Feathers backend with Custom Key Auth Strategy. https://github.com/unrenamed/unkey-feathers

Fixes #2150

Summary by CodeRabbit

  • New Features
    • Added a new contribution entry for a starter template focused on Unkey Route protection in the Hono Webframework.
  • Bug Fixes
    • Removed a duplicate entry for the same project to maintain clarity and uniqueness in the contributions list.

Copy link

changeset-bot bot commented Oct 13, 2024

⚠️ No Changeset found

Latest commit: 2232a7d

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 13, 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 28, 2024 10:41am

Copy link

vercel bot commented Oct 13, 2024

@unrenamed 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 13, 2024

Warning

Rate limit exceeded

@chronark has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between d31d74a and 2232a7d.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request involve adding a new entry for a project titled "Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers" by Prabin Subedi, dated 11-October-2024, to a contributions list. Additionally, it removes a duplicate entry for the same project to maintain uniqueness. The overall structure and requirements for submissions remain unchanged.

Changes

Files Change Summary
oss.gg/7_create_a_template.md - Added new entry for "Starter template for Unkey Route protection in Hono Webframework..."
- Removed duplicate entry for the same project.

Assessment against linked issues

Objective Addressed Explanation
Add a new entry to contributions (2150)
Ensure unique entries in contributions (2150)

Possibly related issues

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

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 13, 2024

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

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)
oss.gg/7_create_a_template.md (1)

41-41: Fix typo and remove extra spaces in the link text

There's a typo in the word "protection" and extra spaces in the link text. Please apply the following changes:

-» 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protecttion in  Hono Webframework in Cloudflare workers ](https://github.com/prabincankod/hono-unkey-cflare)
+» 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers](https://github.com/prabincankod/hono-unkey-cflare)

This will correct the spelling and resolve the Markdownlint warning about spaces inside link text.

🧰 Tools
🪛 Markdownlint

41-41: null
Spaces inside link text

(MD039, no-space-in-links)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7972170 and d31d74a.

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

41-41: null
Spaces inside link text

(MD039, no-space-in-links)

🔇 Additional comments (1)
oss.gg/7_create_a_template.md (1)

41-42: LGTM! New entries added successfully

The new entries for Unkey templates have been added successfully:

  1. Hono Webframework in Cloudflare workers by Prabin Subedi
  2. Feathers API with Custom Key Auth Strategy by Nazar Poshtarenko

These additions align with the PR objectives of introducing new Unkey templates. Great job on contributing to the project!

As a reminder, please ensure that:

  1. The repositories are open source and MIT licensed.
  2. Each repository has a README.md with a quickstart guide.
  3. The templates are unique and not duplicates of existing ones on unkey.com/templates.

To verify the uniqueness and compliance of these new entries, you can run the following script:

This script will help ensure that the new entries meet all the requirements specified in the PR objectives.

✅ Verification successful

Verification Successful! All new Unkey template entries are unique, their repositories exist with proper README files, and both are MIT licensed.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the uniqueness of new entries and check their repositories

# Test 1: Check for duplicates in the file
echo "Checking for duplicates:"
sort oss.gg/7_create_a_template.md | uniq -d

# Test 2: Verify the existence of the repositories and their README files
echo "Verifying repositories:"
gh repo view prabincankod/hono-unkey-cflare
gh repo view unrenamed/unkey-feathers

echo "Checking for README.md files:"
gh api repos/prabincankod/hono-unkey-cflare/contents/README.md
gh api repos/unrenamed/unkey-feathers/contents/README.md

# Test 3: Check if the repositories are MIT licensed
echo "Checking for MIT license:"
gh api repos/prabincankod/hono-unkey-cflare/license
gh api repos/unrenamed/unkey-feathers/license

Length of output: 17978

🧰 Tools
🪛 Markdownlint

41-41: null
Spaces inside link text

(MD039, no-space-in-links)

@chronark chronark merged commit a722273 into unkeyed:main Oct 28, 2024
17 of 21 checks passed
Copy link

oss-gg bot commented Oct 28, 2024

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

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
2 participants