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: add Unkey + Rust SSH echoserver template [SIDE QUEST] #2608

Closed
wants to merge 1 commit into from

Conversation

unrenamed
Copy link
Contributor

@unrenamed unrenamed commented Oct 29, 2024

What does this PR do?

Adds a simple template of an echoserver with built-in API key verification using the Unkey service.

https://github.com/unrenamed/unkey-rust-ssh

Fixes #2150

Summary by CodeRabbit

  • New Features
    • Added a new project entry showcasing a "Secure Rust 🦀 SSH Server with Unkey API Keys."
    • Included a link to the project's GitHub repository for easy access.

Copy link

changeset-bot bot commented Oct 29, 2024

⚠️ No Changeset found

Latest commit: 29d79d0

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 29, 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 29, 2024 4:03pm

Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new entry to the documentation of projects utilizing the Unkey framework for API protection. It specifically adds a contribution by Nazar Poshtarenko titled "Secure Rust 🦀 SSH Server with Unkey API Keys," along with a link to the project's GitHub repository. The entry is dated 29-October-2024 and is formatted consistently with previous contributions, with no other changes made to existing entries or the document structure.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added new entry: » 29-October-2024 by Nazar Poshtarenko [Secure Rust 🦀 SSH Server with Unkey API Keys](https://github.com/unrenamed/unkey-rust-ssh)

Assessment against linked issues

Objective Addressed Explanation
Add new project entries to the documentation (#2150)

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

vercel bot commented Oct 29, 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

github-actions bot commented Oct 29, 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)

Line range hint 1-61: Clean up duplicate entries in the file.

While your new entry is unique, I noticed several duplicate entries in the file that should be cleaned up:

  • "Protect and Rate Limit Rust + Actix Web API with Unkey" (by Novin Noori)
  • "Deno Unkey Ratelimit Starter" (by Devansh Baghel)
  • "FastAPI Unkey Boilerplate" (by Harsh Bhat)
  • "Starter template for Unkey Route protection in Hono Webframework" (by Prabin Subedi)

Consider removing the duplicate entries to maintain a clean and accurate list.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7322cef and 29d79d0.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🔇 Additional comments (3)
oss.gg/7_create_a_template.md (3)

60-61: Entry format is consistent with the template.

The new entry follows the established format correctly, maintaining consistency with other entries.


60-60: Verify template uniqueness on unkey.com/templates.

Please ensure this SSH server template doesn't already exist on https://www.unkey.com/templates.


60-60: Verify repository requirements.

Please ensure the repository at https://github.com/unrenamed/unkey-rust-ssh meets all requirements:

  • MIT license
  • README.md with quickstart instructions
✅ Verification successful

Repository requirements verified successfully

The repository meets all requirements:

  • Open source and publicly accessible
  • MIT license present
  • Comprehensive README.md with detailed quickstart instructions including setup steps and usage examples
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify repository requirements for the new template

# Test 1: Check if the repository exists and is public
gh repo view unrenamed/unkey-rust-ssh

# Test 2: Check for LICENSE and README.md files
gh api repos/unrenamed/unkey-rust-ssh/contents/LICENSE
gh api repos/unrenamed/unkey-rust-ssh/contents/README.md

Length of output: 9061

@harshsbhat
Copy link
Contributor

damn, your templates are genuinely cool and interesting

@chronark
Copy link
Collaborator

/award 750

@chronark chronark closed this Oct 30, 2024
Copy link

oss-gg bot commented Oct 30, 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
3 participants