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(dashboard): on demand config migration #31129

Merged

Conversation

RahulGautamSingh
Copy link
Collaborator

@RahulGautamSingh RahulGautamSingh commented Aug 31, 2024

Changes

  • modify config migration logic to handle the requirements made in linked issue
  • add tests for the same

Context

Closes: #19783

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository
Test Runs

Config Migration: false: checkbox-added, migration pr linked in dd, checkbox-added-when-closed-pr-found, migration-pr-linked (closed-pr-exists)

Config Migration true: pr created & linked no checkbox needed, checkbox-added-if-closed-pr-found, pr-linked-again-after-checkbox-checked (closed-pr-exists)

Modified Migration PR

Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

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

Needs docs. Potentially even a new page to discuss config migration in general which can then be linked from the configMigration docs entry

@rarkins rarkins changed the title feat: on demand config migration feat(dashboard): on demand config migration Sep 2, 2024
Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

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

Also try to use a consistent term in logging so that you can Ctrl-F to search for all applicable messages. e.g. configMigration: or "Config migration" in each message

lib/workers/repository/config-migration/branch/index.ts Outdated Show resolved Hide resolved
lib/workers/repository/config-migration/branch/index.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Lots of suggested changes, to summarize:

  • Add headings
  • Rewrite to focus on the reader
  • Explain a bit more about why we want/need config migration
  • Rewrite the user-facing texts from Renovate about config migration (dashboard text, PR link text, etc.)

docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/configuration-options.md Outdated Show resolved Hide resolved
lib/workers/repository/dependency-dashboard.ts Outdated Show resolved Hide resolved
lib/workers/repository/dependency-dashboard.ts Outdated Show resolved Hide resolved
lib/workers/repository/dependency-dashboard.ts Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
lib/workers/repository/dependency-dashboard.ts Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
rarkins
rarkins previously approved these changes Oct 9, 2024
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
docs/usage/config-migration.md Outdated Show resolved Hide resolved
lib/workers/repository/config-migration/index.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

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

Can be merged after manual testing from @zharinov

Copy link
Collaborator

@zharinov zharinov left a comment

Choose a reason for hiding this comment

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

It worked on my test repo

@rarkins rarkins enabled auto-merge October 17, 2024 08:00
@rarkins rarkins added this pull request to the merge queue Oct 17, 2024
Merged via the queue into renovatebot:main with commit 499ea9c Oct 17, 2024
39 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 38.126.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

On-demand config migration PRs using Dashboard
5 participants