Redoc API 문서 생성 #12
Redoc API 문서 생성 #12
Conversation
GitHub Actions를 이용해 Redoc API 문서도 만들고 배포. References: - https://github.com/Redocly/redoc - https://redocly.com/redoc
Walkthrough이번 PR은 GitHub Actions 워크플로우에 Node.js 환경 설정 단계와 Redocly CLI를 통한 API 문서 생성 단계를 추가합니다. 또한, Todo App 및 Tickets API의 OpenAPI 스펙으로부터 HTML 문서를 생성하는 새로운 명령어 호출이 추가되었으며, 배포 조건이 'main' 브랜치에서만 실행되도록 조정되었습니다. 한편, Changes
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @ahastudio, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request introduces a GitHub Actions workflow to generate and deploy Redoc API documentation, as described in the PR title and description. The change adds public/ to the .gitignore file, presumably to exclude the generated documentation from being tracked by Git.
Highlights
- Redoc API Documentation: Implements a GitHub Actions workflow for generating and deploying Redoc API documentation.
- .gitignore update: Adds
public/to.gitignoreto exclude generated documentation files.
Changelog
- .gitignore
- Added
public/to exclude the generated documentation directory.
- Added
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
From OpenAPI,
A Redoc site takes its form,
Docs now spring to life.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request introduces a GitHub Actions workflow to generate and deploy Redoc API documentation. This is a valuable addition to the project, enhancing its documentation capabilities. The change itself is quite minimal, adding a single line to the .gitignore file.
Merge Readiness
The pull request is a small but useful addition. Since the change is limited to adding a line to .gitignore, it's unlikely to introduce any issues. I am unable to directly approve the pull request, and other reviewers should review and approve this code before merging. Given the nature of the change, it seems reasonable to merge after another review.
There was a problem hiding this comment.
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
.github/workflows/build-and-deploy.yml:42
- [nitpick] If the intent is to restrict the entire deployment job to the main branch, consider moving the condition to the job level rather than applying it only on the deployment step.
if: github.ref == 'refs/heads/main'
| - name: Set up Node.js | ||
| uses: actions/setup-node@v4 | ||
| - name: Install Redocly CLI | ||
| run: npm install -g @redocly/cli@latest |
There was a problem hiding this comment.
Consider pinning the Redocly CLI version instead of using @latest to ensure reproducible builds and avoid unexpected issues in the future.
| run: npm install -g @redocly/cli@latest | |
| run: npm install -g @redocly/cli@1.0.0 |
There was a problem hiding this comment.
버전을 명시할 거면 차라리 진짜 최신 버전인 1.34.1을 쓰는 게 어때?
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request automates the generation and deployment of Redoc API documentation using GitHub Actions. It includes updates to README files to include links to the Redoc documentation and excludes the public/ directory from being tracked in the repository. Overall, this is a good enhancement to improve API documentation accessibility.
Merge Readiness
The pull request is ready to be merged. The changes are straightforward and improve the accessibility of API documentation. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging.
1 participant
GitHub Actions를 이용해 Redoc API 문서도 만들고 배포.
References:
Summary by CodeRabbit