Skip to content

Conversation

@mguida22
Copy link
Collaborator

@mguida22 mguida22 commented Nov 10, 2025

Description of change

Fixes a few redirects and links to the new migration section.

This is currently causing docs builds to fail CI and preventing the changes in #11674 from being deployed.

Pull-Request Checklist

  • Code is up-to-date with the master branch
  • This pull request links relevant issues as Fixes #00000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change

Summary by CodeRabbit

  • Documentation

    • Fixed documentation links and redirects so migrations references point to the specific migrations guide.
    • Updated docs links in Features and Extensions to route directly to the migrations guide.
  • Chores

    • CI now runs validation for documentation changes in pull requests so docs edits undergo the same checks as code.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2025

Walkthrough

Updated documentation links and redirect targets to consolidate migrations paths to /docs/migrations/why, and removed the docs-only paths-ignore from the pull_request trigger so docs changes no longer skip CI validation.

Changes

Cohort / File(s) Summary
Documentation Link Updates
docs/docs/getting-started.md
Replaced two relative migration links (../migrations/01-why.md) with absolute paths (/docs/migrations/why) in the Features and Extensions sections.
Redirect Mapping Updates
docs/redirects.ts
Changed redirect targets for /migrations and /docs/advanced-topics/migrations to point to /docs/migrations/why (previously /docs/migrations).
CI Workflow Trigger Update
.github/workflows/commit-validation.yml
Removed paths-ignore: docs/** from the pull_request trigger so docs changes will trigger the workflow; no other workflow steps modified.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Dev as Developer (PR)
    participant GH as GitHub Actions
    participant Repo as Repository
    Dev->>Repo: Push PR with docs changes
    note right of Repo `#DDEEFF`: Previously docs/** ignored\nby pull_request paths-ignore
    Repo->>GH: Evaluate pull_request triggers
    GH->>GH: Match triggers (docs/** no longer ignored)
    GH->>GH: Run commit-validation workflow
    GH-->>Dev: Report CI results
Loading
sequenceDiagram
    autonumber
    participant User as Client Request
    participant Site as Docs Site Router
    User->>Site: GET /migrations
    Site->>Site: Lookup redirects
    note right of Site `#E8F5E9`: Updated mapping -> /docs/migrations/why
    Site-->>User: 301 Redirect to /docs/migrations/why
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Focus checks:
    • Ensure both updated links in docs/docs/getting-started.md point to the intended target and render correctly.
    • Verify docs/redirects.ts entries are correct and do not create redirect loops.
    • Confirm removal of paths-ignore: docs/** in .github/workflows/commit-validation.yml matches CI intent and the YAML remains valid.

Possibly related PRs

Suggested reviewers

  • alumni
  • naorpeled
  • michaelbromley

Poem

🐰 I hopped through links and mapped the way,

Redirected paths where lost docs lay.
CI now wakes when pages change,
A tidy trail in one small range.
🥕 Hooray — the warren's clear today!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: fix broken migration links' clearly and accurately summarizes the main change—updating broken documentation links to the new migration section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a12611 and 3c117c0.

📒 Files selected for processing (1)
  • .github/workflows/commit-validation.yml (0 hunks)
💤 Files with no reviewable changes (1)
  • .github/workflows/commit-validation.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
  • GitHub Check: tests-linux (20) / mssql
  • GitHub Check: tests-linux (18) / postgres (17)
  • GitHub Check: tests-linux (18) / sqlite
  • GitHub Check: tests-linux (18) / sap
  • GitHub Check: tests-linux (18) / postgres (14)
  • GitHub Check: tests-linux (18) / mssql
  • GitHub Check: tests-linux (18) / mysql_mariadb_latest
  • GitHub Check: tests-linux (18) / mysql_mariadb
  • GitHub Check: tests-linux (18) / mongodb
  • GitHub Check: tests-windows / sqlite
  • GitHub Check: tests-windows / sqljs
  • GitHub Check: tests-windows / better-sqlite3
  • GitHub Check: Analyze (javascript-typescript)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Collaborator

@gioboa gioboa left a comment

Choose a reason for hiding this comment

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

Thanks @mguida22
It looks good to me 👏

@mguida22
Copy link
Collaborator Author

huh it looks like CI is stuck. the jobs have run in my fork but not here (or at least not reported here).

@mguida22
Copy link
Collaborator Author

Looks like checks aren't configured to run on docs only changes

name: Commit Validation
on:
push:
branches:
- "**"
paths-ignore:
- "docs/**"
pull_request:
branches:
- "**"
paths-ignore:
- "docs/**"
workflow_dispatch:

@pkuczynski
Copy link
Collaborator

Looks like checks aren't configured to run on docs only changes

name: Commit Validation
on:
push:
branches:
- "**"
paths-ignore:
- "docs/**"
pull_request:
branches:
- "**"
paths-ignore:
- "docs/**"
workflow_dispatch:

#11761 should solve that issue. But now it fails, as it's missing fixes from this PR :) @michaelbromley maybe we should lift the build-pass requirement for the moment?

Comment on lines -11 to -12
paths-ignore:
- "docs/**"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

this is removed in this PR so CI runs on this change which is docs only.

#11761 will update the workflow so it correctly decides which jobs to run on docs only changes

@coveralls
Copy link

Coverage Status

coverage: 76.433%. remained the same
when pulling 3c117c0 on mguida22:guida/fix-migration-links
into 51fbcf4 on typeorm:master.

@pkuczynski pkuczynski merged commit ba3319d into typeorm:master Nov 11, 2025
60 checks passed
ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026
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.

4 participants