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

git-action 적용 #162

Merged
merged 13 commits into from
Nov 13, 2024
Merged

git-action 적용 #162

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fe9e0bc
♻️ 코드 수정 : ignore 수정
JoJeHuni Nov 13, 2024
330ddc0
♻️ 코드 수정 : application.yml 수정으로 인한 커밋
JoJeHuni Nov 13, 2024
a66f2ad
✨ 기능 추가 : git-action 적용
JoJeHuni Nov 13, 2024
9ee8075
✨ 기능 수정 : 프롬프트 변경
JoJeHuni Nov 13, 2024
6d8d0c2
✨ 기능 수정 : 프롬프트 변경
JoJeHuni Nov 13, 2024
78df6b4
✨ 기능 수정 : 프롬프트 변경
JoJeHuni Nov 13, 2024
b58e96f
♻️ 코드 수정 : deploy.yml 수정
JoJeHuni Nov 13, 2024
90104e5
♻️ 코드 수정 : deploy.yml 수정
JoJeHuni Nov 13, 2024
8273961
♻️ 코드 수정 : gitignore 수정
JoJeHuni Nov 13, 2024
0a75660
✨ 기능 추가 : gradlew 추가
JoJeHuni Nov 13, 2024
0ff411c
♻️ 코드 수정 : gitignore 수정
JoJeHuni Nov 13, 2024
1f0b435
♻️ 코드 수정 : gitignore 수정
JoJeHuni Nov 13, 2024
ff08948
♻️ 코드 수정 : gradle 관련 파일 추가
JoJeHuni Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .github/workflows/deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: learnsmate-service

permissions:
contents: read
pull-requests: write

on:
pull_request:
types: [ opened, reopened, synchronize ]
push:
branches:
- "main"

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up JDK 17
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'corretto'

- name: Grant execute permission for gradlew
run: chmod +x ./gradlew
shell: bash
##############################################################
# 이후 이 부분은 envsubst가 추가될 예정
##############################################################


- name: Build with Gradle
run: ./gradlew clean build -x test
shell: bash

- name: Get current time
uses: 1466587594/get-current-time@v2
id: current-time
with:
format: YYYY-MM-DDTHH-mm-ss
utcOffset: "+09:00"

- name: Show Current Time
run: echo "CurrentTime=${{steps.current-time.outputs.formattedTime}}"
shell: bash

- name: ChatGPT codeReviewer
uses: anc95/ChatGPT-CodeReview@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

# Optional
LANGUAGE: Korean
OPENAI_API_ENDPOINT: https://api.openai.com/v1
MODEL: gpt-4o # https://platform.openai.com/docs/models
PROMPT: 코드 변경 내용을 검토하고 오류 또는 개선점을 찾아서 한글로 작성해주세요.
top_p: 1 # https://platform.openai.com/docs/api-reference/chat/create#chat/create-top_p
temperature: 1 # https://platform.openai.com/docs/api-reference/chat/create#chat/create-temperature
max_tokens: 10000
MAX_PATCH_LENGTH: 10000
Copy link

Choose a reason for hiding this comment

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

Code Review Summary:

Bugs/Risks:

  1. Missing Newline at End of File: The file is missing a newline character at the end, which could cause issues in some scenarios.

Suggested Improvements:

  1. Comments Clarity: While comments exist, it would be beneficial to provide more descriptive comments for each step or section to aid in code readability and understanding.

  2. Security Concerns: Ensure that sensitive information like API keys stored in secrets (e.g., GITHUB_TOKEN, OPENAI_API_KEY) is appropriately handled and secured following best practices.

  3. Consistent Syntax: Ensure consistent use of syntax styles throughout the codebase for better maintainability.

  4. Testing: Consider adding testing steps, especially after the build process, to ensure the integrity of the build artifact.

  5. Failure Handling: Implement error handling and appropriate response mechanisms, such as notifications or logging, for failed steps to improve debugging and maintenance.

  6. Documentation: Add a high-level overview comment at the beginning of the file explaining the purpose of this workflow.

  7. Version Control: Regularly review and update dependencies, such as GitHub Actions and external tools like setup-java or actions/checkout, to avoid compatibility issues.

Given these suggestions, you can enhance the code's robustness, stability, and maintainability while promoting a safer and more efficient workflow.

Copy link

Choose a reason for hiding this comment

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

Code Review:

  1. Permissions and Triggers:

    • Verify if the permissions set (read for contents and write for pull-requests) are appropriate for the actions being performed.
    • Ensure that triggering events (pull_request, push) cover all necessary scenarios.

  2. Job Execution:

    • Confirm if the correct operating system (ubuntu-latest) is being used.
    • Check if JDK 17 setup is required and if 'corretto' distribution is suitable.
    • Ensure that the chmod +x ./gradlew step is functioning as intended.
    • Future addition of envsubst needs to be properly integrated and tested.

  3. Gradle Build:

    • Running Gradle tasks (./gradlew clean build -x test) without testing might lead to deployment issues if tests are insufficient elsewhere.

  4. Time Management:

    • The usage of 1466587594/get-current-time@v2 is appropriate, but verify if the time format (YYYY-MM-DDTHH-mm-ss) meets project requirements.

  5. ChatGPT Integration:

    • Validate the configuration for the ChatGPT code reviewer:
      • Ensure the correct model, prompt, language, and API endpoint are used.
      • Parameters like top_p, temperature, and max_tokens should align with expected behaviors.
      • Consider security implications of passing OpenAI and GitHub tokens as secrets.

  6. General:

    • Add a new line at the end of the file for better compatibility with some tools.

Potential Improvements:

  • Implement a testing step after the Gradle build to ensure the code's functionality.
  • Add error handling mechanisms in case any step fails to prevent pipeline disruptions.
  • Consider adding linting or static code analysis steps for better code quality control.
  • Enhance logging to provide more informative messages during workflow execution.
  • Ensure standardized formatting across the entire codebase for better maintainability.

Overall, conduct thorough testing, especially after incorporating envsubst. Ensure each step functions correctly and consider enhancing error management for a more robust CI/CD process.

2 changes: 1 addition & 1 deletion LearnsMate/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ bin/
!**/src/test/**/bin/

### IntelliJ IDEA ###
*.yml
application-test.yml
.idea
*.json
*.iws
Copy link

Choose a reason for hiding this comment

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

Code Review

  1. Risk Assessment:

    • Risk: Changing the exclusion from *.yml to application-test.yml in the IntelliJ IDEA configuration could potentially introduce problems if other YAML files need to be excluded from the version control.

  2. Improvement Suggestions:

    • Consideration: If the intention is only to exclude a specific application-test.yml file while ignoring all other .yml files, it's better to maintain the original wildcard exclusion *.yml and add an explicit exclusion for application-test.yml.
    • Consistency: Ensure consistency in naming and patterns across exclusion rules to improve readability and maintenance.

  3. Suggestion:

    ### IntelliJ IDEA ###
*.yml
!application-test.yml
.idea/
*.json
*.iws

  4. Overall:

    • The provided patch may introduce potential risks due to the specificity of the exclusion rule for application-test.yml. Consider a more general approach for excluding specific YAML files while maintaining flexibility for future changes.

Final Patch with Suggested Changes

@@ -27,7 +27,7 @@ bin/
 !**/src/test/**/bin/
 
 ### IntelliJ IDEA ###
-*.yml
+!application-test.yml
 .idea/
 *.json
 *.iws

Always ensure to thoroughly test your version control setup after making such changes to prevent unexpected issues in your development workflow.

Expand Down
3 changes: 3 additions & 0 deletions LearnsMate/src/main/resources/application.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
spring:
profiles:
active: test
Copy link

Choose a reason for hiding this comment

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

This code snippet appears to be a YAML configuration file that sets the active profiles for a Spring application. Here is a brief code review and some suggestions:

  1. No newline at end of file:
    This is a minor issue flagged by version control systems like Git, which prefer having a newline at the end of files. It's generally a good practice to have one, but it won't affect the functionality.

  2. Profile Activation:
    The code sets the active profile to "test". Ensure that this profile is correctly set up in your project's configuration and that it aligns with the intended use case.

  3. Safety and Best Practices:

    • Confirm that sensitive information such as passwords or API keys are not stored directly in this configuration file.
    • Consider encrypting or using secure methods to handle any confidential data if included in the profiles.

  4. Documentation:

    • Make sure to document the purpose of this profile and any specific configurations that need to be applied when 'test' profile is active.

  5. Testing:
    Verify that the application behaves as expected when using the 'test' profile. Test environment configurations should align with what your tests expect.

  6. Versioning:
    Regularly review and update your profiles based on evolving requirements. Ensure compatibility with newer versions of Spring Boot and any related libraries.

Overall, the code appears simple and straightforward. Watching for the mentioned points could help maintain the effectiveness and security of your application.

Loading