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

ドキュメントの更新 #1075

Merged
merged 3 commits into from
Dec 15, 2024
Merged

ドキュメントの更新 #1075

merged 3 commits into from
Dec 15, 2024

Conversation

ikura-hamu
Copy link
Member

@ikura-hamu ikura-hamu commented Dec 15, 2024

User description

  • 📝 src/README.mdを更新
  • 📝 READMEの更新
  • 📝 DBスキーマ

PR Type

Documentation, Enhancement


Description

  • README.mdのセットアップ手順を更新し、古いv1 APIの記述を削除しました。また、権限エラーに関するトラブルシューティングを追加しました。
  • データベーススキーマの複数のテーブルで、ユニークキーの名前を変更し、関連するインデックスや制約を更新しました。
  • gamesテーブルに新しいカラムlatest_version_updated_atを追加しました。
  • src/README.mdのリンクを更新し、不要な空行を削除しました。

Changes walkthrough 📝

Relevant files
Documentation
19 files
README.md
Update setup instructions and remove outdated v1 API notes

README.md

  • Updated the go install command to use the latest version.
  • Removed outdated instructions for v1 API-only startup.
  • Added troubleshooting instructions for permission issues.
  • +2/-6     
    README.md
    Update version number for `games` table                                   

    docs/db_schema/README.md

    • Updated the version number for the games table.
    +1/-1     
    access_tokens.md
    Rename unique key for `access_token` in schema                     

    docs/db_schema/access_tokens.md

  • Renamed the unique key for access_token.
  • Updated related indexes and constraints.
  • +3/-3     
    editions.md
    Rename unique key for `name` in `editions` table                 

    docs/db_schema/editions.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    game_file_types.md
    Rename unique key for `name` in `game_file_types` table   

    docs/db_schema/game_file_types.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    game_genre_relations.md
    Add new foreign key constraints in `game_genre_relations`

    docs/db_schema/game_genre_relations.md

  • Added new foreign key constraints for genre_id and game_id.
  • Updated related indexes.
  • +6/-2     
    game_genres.md
    Rename unique key for `name` in `game_genres` table           

    docs/db_schema/game_genres.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    game_image_types.md
    Rename unique key for `name` in `game_image_types` table 

    docs/db_schema/game_image_types.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    game_management_role_types.md
    Rename unique key for `name` in `game_management_role_types` table

    docs/db_schema/game_management_role_types.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    game_urls.md
    Rename unique key for `game_version_id` in `game_urls` table

    docs/db_schema/game_urls.md

  • Renamed the unique key for game_version_id.
  • Updated related indexes and constraints.
  • +3/-3     
    game_video_types.md
    Rename unique key for `name` in `game_video_types` table 

    docs/db_schema/game_video_types.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    game_visibility_types.md
    Rename unique key for `name` in `game_visibility_types` table

    docs/db_schema/game_visibility_types.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    games.md
    Add `latest_version_updated_at` column to `games` table   

    docs/db_schema/games.md

    • Added a new column latest_version_updated_at with default value.
    +2/-0     
    launcher_sessions.md
    Rename unique key for `access_token` in `launcher_sessions` table

    docs/db_schema/launcher_sessions.md

  • Renamed the unique key for access_token.
  • Updated related indexes and constraints.
  • +3/-3     
    launcher_users.md
    Rename unique key for `product_key` in `launcher_users` table

    docs/db_schema/launcher_users.md

  • Renamed the unique key for product_key.
  • Updated related indexes and constraints.
  • +3/-3     
    launcher_versions.md
    Rename unique key for `name` in `launcher_versions` table

    docs/db_schema/launcher_versions.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    product_key_statuses.md
    Rename unique key for `name` in `product_key_statuses` table

    docs/db_schema/product_key_statuses.md

  • Renamed the unique key for name.
  • Updated related indexes and constraints.
  • +3/-3     
    product_keys.md
    Rename unique key for `product_key` in `product_keys` table

    docs/db_schema/product_keys.md

  • Renamed the unique key for product_key.
  • Updated related indexes and constraints.
  • +3/-3     
    README.md
    Update links and clean up `src/README.md`                               

    src/README.md

  • Updated links for repository and handler sections.
  • Removed unnecessary blank line.
  • +2/-3     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Update
    The addition of a troubleshooting step for Permission denied errors is helpful, but it involves using sudo rm -rf mysql, which can be risky. Consider adding a warning or alternative safer steps.

    Schema Change
    A new column latest_version_updated_at has been added to the games table. Ensure that this change is backward-compatible and does not affect existing functionality.

    Unique Key Update
    The unique key for access_token has been renamed to uni_access_tokens_access_token. Verify that this change does not break any existing queries or constraints.

    Documentation Consistency
    The update to the handler and repository descriptions reflects the use of new tools. Ensure that all related documentation and code references are consistent with this change.

    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Copy link

    codecov bot commented Dec 15, 2024

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 49.85%. Comparing base (34ae17e) to head (137ea70).
    Report is 4 commits behind head on main.

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##             main    #1075   +/-   ##
    =======================================
      Coverage   49.85%   49.85%           
    =======================================
      Files         121      121           
      Lines       10986    10986           
    =======================================
      Hits         5477     5477           
      Misses       5171     5171           
      Partials      338      338           

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

    @ikura-hamu ikura-hamu merged commit 13e4165 into main Dec 15, 2024
    11 checks passed
    @ikura-hamu ikura-hamu deleted the docs/src_doc branch December 15, 2024 03:04
    @ikura-hamu ikura-hamu linked an issue Dec 15, 2024 that may be closed by this pull request
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    開発用ドキュメント整備
    1 participant