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

refactor: move discord and github redirects into next configs #2643

Merged
merged 5 commits into from
Nov 7, 2024

Conversation

gokaygurcan
Copy link
Contributor

@gokaygurcan gokaygurcan commented Nov 4, 2024

What does this PR do?

Moves social redirects (discord and github) into next.config.js file.

Fixes #2637

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?

  • Open unkey.com/discord, it should land on Discord invite page without rendering unkey.com in between.
  • Open unkey.com/github, it should land on GitHub repository page without rendering unkey.com in between.

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

  • New Features
    • Implemented permanent redirects for /discord to Discord and /github to GitHub.
  • Bug Fixes
    • Removed outdated redirect functions for Discord and GitHub.
  • Chores
    • Updated configuration to streamline redirect rules, enhancing navigation efficiency.

Signed-off-by: Gökay Gürcan <github@gokaygurcan.com>
Copy link

changeset-bot bot commented Nov 4, 2024

⚠️ No Changeset found

Latest commit: 081b7da

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 Nov 4, 2024

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 1 unresolved
✅ 5 resolved
Nov 7, 2024 8:08am
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2024 8:08am
play ✅ Ready (Inspect) Visit Preview 💬 23 unresolved
✅ 5 resolved
Nov 7, 2024 8:08am
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2024 8:08am
www ✅ Ready (Inspect) Visit Preview 💬 2 unresolved
✅ 1 resolved
Nov 7, 2024 8:08am

@CLAassistant
Copy link

CLAassistant commented Nov 4, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

vercel bot commented Nov 4, 2024

@gokaygurcan 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 Nov 4, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve the removal of two files, page.tsx from the discord and github directories, which contained functions for redirecting users to specific URLs. The DiscordRedirect function was responsible for redirecting to a Discord link, while the GitHubRedirect function (incorrectly named) was intended to redirect to a GitHub URL. Additionally, new redirect rules have been added to the next.config.js file to handle these redirects at the application level.

Changes

File Path Change Summary
apps/www/app/discord/page.tsx Removed the DiscordRedirect function that redirected to Discord URL.
apps/www/app/github/page.tsx Removed the incorrectly named DiscordRedirect function that redirected to GitHub URL.
apps/www/next.config.js Added new redirect rules for /discord to Discord URL and /github to GitHub URL, marked as permanent. Rewrites for the same paths were also added.

Assessment against linked issues

Objective Addressed Explanation
Correct function name in GitHub redirect (2637) The function was removed instead of being renamed.

Possibly related PRs

  • chore: add roadmap link in the footer #2291: The addition of a redirect for the "Roadmap" link in the footer is conceptually similar to the removal of the DiscordRedirect function, as both involve URL redirection logic within the application.

Suggested labels

🕹️ oss.gg, :joystick: 150 points

Suggested reviewers

  • mcstepp
  • chronark
  • MichaelUnkey
  • perkinsjr

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.

@gokaygurcan gokaygurcan mentioned this pull request Nov 4, 2024
18 tasks
@github-actions github-actions bot added Bug Something isn't working Needs Approval Needs approval from Unkey labels Nov 4, 2024
Copy link
Contributor

github-actions bot commented Nov 4, 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: 1

🧹 Outside diff range and nitpick comments (1)
apps/www/next.config.js (1)

33-42: Consider adding status codes to redirects.

Since these are permanent redirects to external URLs, it would be good practice to explicitly set the status code to 301.

      {
        source: "/discord",
        destination: "https://discord.gg/fDbezjbJbD",
        permanent: true,
+       statusCode: 301
      },
      {
        source: "/github",
        destination: "https://github.com/unkeyed/unkey",
        permanent: true,
+       statusCode: 301
      }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 06cf362 and 5a45c28.

📒 Files selected for processing (3)
  • apps/www/app/discord/page.tsx (0 hunks)
  • apps/www/app/github/page.tsx (0 hunks)
  • apps/www/next.config.js (1 hunks)
💤 Files with no reviewable changes (2)
  • apps/www/app/discord/page.tsx
  • apps/www/app/github/page.tsx

apps/www/next.config.js Outdated Show resolved Hide resolved
Signed-off-by: Gökay Gürcan <github@gokaygurcan.com>
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/www/next.config.js (1)

34-71: LGTM! Well-structured redirects configuration

The implementation successfully:

  • Moves Discord and GitHub redirects into next.config.js
  • Ensures direct navigation without intermediate pages
  • Maintains consistency with other redirects

Consider moving the destination URLs to environment variables for easier maintenance, especially for URLs that might change (like Discord invite links).

// Example implementation
-        destination: "https://discord.gg/fDbezjbJbD",
+        destination: process.env.DISCORD_INVITE_URL,
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eb8e9fb and fc8b5b0.

📒 Files selected for processing (1)
  • apps/www/next.config.js (1 hunks)
🔇 Additional comments (2)
apps/www/next.config.js (2)

26-33: LGTM! Clean rewrites configuration

The rewrites section is now focused solely on changelog routing, with no duplicate configurations for Discord or GitHub paths. This aligns with best practices for Next.js routing.


57-60: Verify Discord invite link permanence

The Discord invite link is set as a permanent redirect. Please confirm that this invite link is permanent and won't expire.

@chronark chronark added this pull request to the merge queue Nov 7, 2024
Merged via the queue into unkeyed:main with commit b39261c Nov 7, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Needs Approval Needs approval from Unkey
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Copy paste error
3 participants