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

Update build-sdk.sh #637

Merged
merged 1 commit into from
Nov 4, 2024
Merged

Conversation

MaximeWeyl
Copy link
Contributor

@MaximeWeyl MaximeWeyl commented Nov 4, 2024

The install instruction does not work anymore, updated it with the new install instruction from https://github.com/oapi-codegen/oapi-codegen

Summary by CodeRabbit

  • Chores
    • Updated the installation command for the OpenAPI code generator in the build script, ensuring continued functionality and access to the latest SDK generation tools.

The install instruction does not work anymore, updated it with the new install instruction from https://github.com/oapi-codegen/oapi-codegen
Copy link

coderabbitai bot commented Nov 4, 2024

Walkthrough

The changes involve an update to the installation command for the OpenAPI code generator in the build-sdk.sh script. The command now points to a different repository, indicating a shift in the source for the SDK generator while keeping the rest of the script unchanged.

Changes

File Path Change Summary
docs/terminal/build-sdk.sh Updated installation command for OpenAPI code generator from github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@latest to github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BuildScript as Build Script
    participant CodeGenerator as OpenAPI Code Generator

    User->>BuildScript: Run build-sdk.sh
    BuildScript->>CodeGenerator: Install oapi-codegen
    CodeGenerator-->>BuildScript: Confirm installation
    BuildScript-->>User: SDK generated successfully
Loading

🐇 "In the script where we build and play,
A new path for codegen leads the way.
From deepmap's realm to a fresh new site,
Our SDK shines, oh what a delight!
Hops of joy with every line,
In the code garden, all will be fine!" 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d67ab01 and 6f3b12e.

📒 Files selected for processing (1)
  • docs/terminal/build-sdk.sh (1 hunks)
🔇 Additional comments (2)
docs/terminal/build-sdk.sh (2)

Line range hint 1-13: Script structure remains sound and compatible.

The script's workflow and commands remain valid with the new generator version. The consistent command structure (oapi-codegen) and parameters suggest backward compatibility is maintained.


6-6: LGTM! Verify compatibility with the new repository.

The update to use the new repository location is correct and matches the official source.

Let's verify the repository's authenticity and check for any breaking changes:

✅ Verification successful

Let me gather more information about the old repository to make a complete verification.


Let me try one final verification to check the relationship between these repositories by looking at their git history.


Repository update is correct and verified

The change to oapi-codegen/oapi-codegen is verified to be correct. The evidence shows:

  • Both repositories are actually the same repository (identical nameWithOwner)
  • They share the same latest release (v2.4.1)
  • The repository has significant adoption (6263 stars)
  • It's actively maintained (last push: November 2024)
  • The repository has simply been transferred to its own organization
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the repository and its relationship with the old one

# Check if the old repository mentions migration
echo "Checking for migration notice in the old repository..."
gh repo view deepmap/oapi-codegen --json description,url,archived

# Check the new repository's information
echo "Verifying the new repository..."
gh repo view oapi-codegen/oapi-codegen --json description,url,stargazerCount,createdAt

Length of output: 1674


Script:

#!/bin/bash
# Check the old repository's details and latest activity
gh repo view deepmap/oapi-codegen --json description,url,isArchived,stargazerCount,createdAt,pushedAt

# Check if there are any references to migration in the README of both repos
echo "Checking old repo's README..."
gh repo view deepmap/oapi-codegen --json readme | jq -r '.readme.text' | grep -i "migrat\|move\|transfer" || true

echo "Checking new repo's README..."
gh repo view oapi-codegen/oapi-codegen --json readme | jq -r '.readme.text' | grep -i "migrat\|move\|transfer" || true

Length of output: 2979


Script:

#!/bin/bash
# Check if one repository is a fork of another or if they share history
echo "Checking repository relationships..."
gh repo view deepmap/oapi-codegen --json isFork,parent,nameWithOwner
gh repo view oapi-codegen/oapi-codegen --json isFork,parent,nameWithOwner

# Get the latest release information from both repos
echo "Checking latest releases..."
gh release list --repo deepmap/oapi-codegen --limit 1
gh release list --repo oapi-codegen/oapi-codegen --limit 1

Length of output: 709


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
Owner

@danielgtaylor danielgtaylor left a comment

Choose a reason for hiding this comment

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

Thank you! 🎉

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.90%. Comparing base (d67ab01) to head (6f3b12e).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #637   +/-   ##
=======================================
  Coverage   92.90%   92.90%           
=======================================
  Files          22       22           
  Lines        4848     4848           
=======================================
  Hits         4504     4504           
  Misses        299      299           
  Partials       45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@danielgtaylor danielgtaylor merged commit a74067b into danielgtaylor:main Nov 4, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants