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.

Sign up for GitHub

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

Jump to bottom

chore: expired keys batch management toolkit [SIDE QUEST] #2539

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: expired keys batch management toolkit [SIDE QUEST] #2539

wants to merge 1 commit into from

Conversation

unrenamed
Copy link
Contributor

@unrenamed unrenamed commented Oct 22, 2024 •
edited by coderabbitai bot
Loading

What does this PR do?

Adds a template that showcases how to seed your Unkey API with expired keys and perform a fast, efficient cleanup of those keys with a single command.

Yeah, I know that Unkey Hacktoberfest Side Quests & Challenges recommend building an API protected with Unkey. However, many existing JS/TS templates are repetitive and don't showcase new ways to use the Unkey SDK beyond just the environment. This template can help developers understand the SDK's capabilities and provide practical approaches not covered in the official documentation. Deleting expired keys is a common task, so this sample could be valuable for SDK users looking to implement similar features in their apps.

https://github.com/unrenamed/unkey-expired-keys-cleanup

Fixes #2150

Summary by CodeRabbit

  • New Features
    • Added a new project entry for "Batch Management of Expired Unkey API Keys" by Nazar Poshtarenko, enhancing the list of resources for API protection.
    • Included a link to the project's GitHub repository for easy access.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 22, 2024

⚠️ No Changeset found

Latest commit: 2b437b9

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 Vercel
Copy link

vercel bot commented Oct 22, 2024 •
edited
Loading

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 22, 2024 6:36pm

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 22, 2024 •
edited
Loading

📝 Walkthrough

Walkthrough

This pull request introduces a new entry in the oss.gg/7_create_a_template.md document, detailing a project titled "Batch Management of Expired Unkey API Keys." The entry includes the author’s name, date of creation, and a link to the GitHub repository. The format adheres to the existing structure for project submissions, maintaining the requirements for originality and open-source licensing.

Changes

File Change Summary
oss.gg/7_create_a_template.md Added a new project entry: "Batch Management of Expired Unkey API Keys" by Nazar Poshtarenko, dated 22-October-2024, with a GitHub link.

Assessment against linked issues

Objective Addressed Explanation
Add a new entry for a project in the list (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.

@vercel Vercel
Copy link

vercel bot commented Oct 22, 2024

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

A member of the Team first needs to authorize it.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 22, 2024 •
edited
Loading

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

@unrenamed unrenamed changed the title chore: expired keys batch management toolkit chore: expired keys batch management toolkit [SIDE QUEST] Oct 22, 2024
coderabbitai[bot]
coderabbitai bot reviewed Oct 22, 2024
View reviewed changes
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)

58-58: Remove the extra newline for consistency.

The extra blank line after the entry differs from the format of other entries in the list.

 » 22-October-2024 by Nazar Poshtarenko [Batch Management of Expired Unkey API Keys](https://github.com/unrenamed/unkey-expired-keys-cleanup)
-
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

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

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

57-57: LGTM! The template submission meets all requirements.

The new entry follows the correct format and introduces a unique template that demonstrates practical SDK capabilities for managing expired keys.

@chronark
Copy link
Collaborator

Hmm, I'm not sure how I feel about this. It's true that most templates are pretty basic, but this would be much better suited as documentation, rather than templates I think

@unrenamed
Copy link
Contributor Author

but this would be much better suited as documentation

like a tutorial or dev blog post on how to clean up your Unkey API from all expired keys? I like this.

Any ideas where would it suit best — Blogs or Docs (and which part)?

@chronark
Copy link
Collaborator

tbh either one could work, but we'll probably be too late for hacktoberfest, I've sent you a discord dm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@perkinsjr perkinsjr Awaiting requested review from perkinsjr perkinsjr is a code owner

@chronark chronark Awaiting requested review from chronark chronark is a code owner

@mcstepp mcstepp Awaiting requested review from mcstepp mcstepp is a code owner

@MichaelUnkey MichaelUnkey Awaiting requested review from MichaelUnkey MichaelUnkey is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
hacktoberfest 🕹️ oss.gg
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[🕹️] SIDE QUESTS: https://go.unkey.com/ossgg-challenges
2 participants
@unrenamed @chronark