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

feat(nx-dev): generate migration detail pages #29580

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

isaacplmann
Copy link
Collaborator

@isaacplmann isaacplmann commented Jan 10, 2025

Generates migration detail pages for every migration

To add sample code changes for a migration that has an implementation file, create a .md file with the same name as the implementation file in the same folder as the implementation file. i.e. move-cache-directory.md for move-cache-directory.ts.

Migrations that have packages defined will have a table generated with the package updates listed.

Separate PRs will be created to add sample code changes for each migration with an implementation.

The migration list on the plugin overview page: Angular migrations
Sample migration with added markdown file details: 17.0.0-move-cache-directory
Sample migration with only package updates: Angular 16.4.0
Sample migration without any markdown file details: 17.0.0-use-minimal-config-for-tasks-runner-options

  • This last sample is very bare-bones and the reason why we need these pages in the first place. People don't know what migrations are actually doing. Follow up PRs will address pages like this.

Copy link

nx-cloud bot commented Jan 10, 2025

View your CI Pipeline Execution ↗ for commit 05e8d38.

Command Status Duration Result
nx affected --targets=lint,test,build,e2e,e2e-c... ✅ Succeeded 5m 23s View ↗
nx run-many -t check-imports check-commit check... ✅ Succeeded 23s View ↗
nx-cloud record -- nx format:check --base=df27a... ✅ Succeeded 6s View ↗
nx-cloud record -- nx-cloud conformance:check ✅ Succeeded 1s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded <1s View ↗
nx documentation --no-dte ✅ Succeeded <1s View ↗
nx affected -t e2e-macos-local --parallel=1 --b... ✅ Succeeded 1s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-13 16:38:25 UTC

Copy link

vercel bot commented Jan 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Jan 13, 2025 4:36pm

@leosvelperez
Copy link
Member

@isaacplmann do we plan to render the requirements some migrations have? I think it would make sense to do so as it adds clarity about why some migrations might run or not. Examples of those requirements:

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