Skip to content

Conversation

@ikura-hamu
Copy link
Member

@ikura-hamu ikura-hamu commented May 5, 2025

User description

  • 📝 古いマイグレーションをdeprecatedにする
  • 📝 古いマイグレーションについて追記
  • 📝 README更新

PR Type

Documentation


Description

  • migrateパッケージをDeprecated注釈で非推奨化

  • READMEにAtlasインストール手順を追加

  • READMEへmigration.md参照箇所を追記

  • docs/migration.mdに移行説明を追加


Changes walkthrough 📝

Relevant files
Documentation
migrate.go
migrateパッケージ非推奨化注釈追加                                                                         

src/repository/gorm2/migrate/migrate.go

  • migrateパッケージにDeprecatedコメント追加
  • 新しいschemaパッケージの使用を推奨
+4/-0     
README.md
READMEにマイグレーション説明追加                                                                           

README.md

  • Atlasインストール案内を追記
  • migration.mdへのリンクを追加
+7/-0     
migration.md
旧マイグレーション移行説明追加                                                                                   

docs/migration.md

  • 旧gormigrateからAtlas移行手順追加
  • src/repository/gorm2/migrateパス説明
  • migrateパッケージの今後の方針記載
  • +5/-0     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @github-actions
    Copy link

    github-actions bot commented May 5, 2025

    Migrate lint

    Lint output
    
    

    @github-actions
    Copy link

    github-actions bot commented May 5, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

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

    Doc Comment Format

    Go package documentation comments should start with "Package migrate" to follow godoc conventions rather than just "// migrate".

    // migrate
    //
    // Deprecated: migrate パッケージは、古いマイグレーションのコードです。
    // 代わりに [github.com/traPtitech/trap-collection-server/src/repository/gorm2/schema] パッケージを使用してください。
    Link Path Verification

    Ensure that the relative links to migration.md and src paths resolve correctly in various renderers (GitHub, IDE markdown preview).

    また、マイグレーションツールとして [Atlas](https://atlasgo.io/)を使用しているので、インストールしてください。詳しくは [migration.md](docs/migration.md) を参照してください。
    
    

    @github-actions
    Copy link

    github-actions bot commented May 5, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @codecov
    Copy link

    codecov bot commented May 5, 2025

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 49.15%. Comparing base (82964b1) to head (50c772e).
    Report is 6 commits behind head on main.

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##             main    #1218   +/-   ##
    =======================================
      Coverage   49.15%   49.15%           
    =======================================
      Files         127      127           
      Lines       11301    11301           
    =======================================
      Hits         5555     5555           
      Misses       5448     5448           
      Partials      298      298           

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

    🚀 New features to boost your workflow:
    • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

    @ikura-hamu ikura-hamu merged commit fc2075b into main May 5, 2025
    13 checks passed
    @ikura-hamu ikura-hamu deleted the chore/deprecate_old_migrations branch May 5, 2025 12:52
    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.

    2 participants