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

ci: add reviewdog workflow for yamllint action #1201

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

waterfallmouse
Copy link

@waterfallmouse waterfallmouse commented Aug 3, 2024

Overview

This PR involves formatting improvements to the ReEarth-CMS Integration API schema definition file, as well as the addition of GitHub Actions to enhance our code review process.

What I've done

  • Formatted the YAML file to fix inconsistencies in indentation and unify formatting styles.
  • Cleaned up the structure of responses and requests for each API endpoint to enhance readability.
  • Added a new GitHub Actions workflow file .github/workflows/reviewdog.yml to integrate reviewdog with yamllint for automated linting on pull requests.

What I haven't done

  • Since these changes do not affect the functionality of the APIs, I have not conducted endpoint functionality tests.
  • This PR does not include any changes or additions to API functionalities.

How I tested

  • I parsed the file in a local environment to ensure the YAML syntax was correct.
  • Used a visual diff tool to confirm that there were no unintended differences between the versions before and after the changes.
  • Tested the new GitHub Actions workflow by simulating a pull request to ensure it triggers correctly and performs the intended linting tasks.

Screenshot

  • None.

Which point I want you to review particularly

  • Please review if there are any further improvements that could be made to the formatting of the YAML file.
  • Feedback on the setup and configuration of the GitHub Actions workflow would be appreciated to ensure it meets our CI/CD standards.

Memo

  • The main purpose of these changes is to improve readability and maintainability.
  • The addition of the GitHub Actions workflow is aimed at automating our review process, ensuring consistent code quality, and streamlining our development workflow.
  • This cleanup of the foundational schema sets the stage for future changes and expansions to the API.

Copy link

netlify bot commented Aug 3, 2024

Deploy Preview for reearth-cms canceled.

Name Link
🔨 Latest commit c521f95
🔍 Latest deploy log https://app.netlify.com/sites/reearth-cms/deploys/66b33eb9acc0bd0008813ede

@rot1024 rot1024 changed the title Chore: add reviewdog workflow for yamllint action chore: add reviewdog workflow for yamllint action Aug 7, 2024
@rot1024 rot1024 changed the title chore: add reviewdog workflow for yamllint action chore(server): add reviewdog workflow for yamllint action Aug 7, 2024
@rot1024 rot1024 force-pushed the chore/add-reviewdog-workflow-for-yamllint-action branch from ff66cf0 to c521f95 Compare August 7, 2024 09:30
Copy link

codecov bot commented Aug 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.59%. Comparing base (3a36a1c) to head (c521f95).
Report is 119 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1201      +/-   ##
==========================================
- Coverage   46.36%   44.59%   -1.77%     
==========================================
  Files         324      313      -11     
  Lines       22633    20927    -1706     
==========================================
- Hits        10493     9333    -1160     
+ Misses      11455    10921     -534     
+ Partials      685      673      -12     
Flag Coverage Δ
server 44.59% <ø> (-2.67%) ⬇️
worker ?

Flags with carried forward coverage won't be shown. Click here to find out more.

see 296 files with indirect coverage changes

@waterfallmouse waterfallmouse changed the title chore(server): add reviewdog workflow for yamllint action ci: add reviewdog workflow for yamllint action Aug 9, 2024
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