Adding a helper script for Bzlmod migration. #74
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The script does the following things:
- 1. Run the build without Bzlmod enabled to generate resolved external
dependencies with --experimental_repository_resolved_file
- 2. Run the build with Bzlmod enabled and identify recongnized error message
- 3. Use the resolved external deps info to give migration suggestions.
- 4. Repeat 2 and 3 until all external deps are available via Bzlmod (or WORKSPACE.bzlmod).
To start the migration, clone the Bazel central registry repo and run the following command from your project root:
```
<path to a local BCR repo>/tools/migrate_to_bzlmod.py <build flags> <build targets>
```
Wyverald
reviewed
Mar 14, 2022
tools/migrate_to_bzlmod.py
Outdated
| f"Please remove the usages of refering your own repo via `@{repo}//`, targets should be referenced directly with `//`. ") | ||
| eprint("If it's used in a macro, you can use `Label(\"//foo/bar\")` to make sure it alwasy points to your repo no matter where the macro is used.") | ||
| eprint(f"You can temporarily work around this by changing your module name to {WORKSPACE_NAME} and adding `workspace(name = '{WORKSPACE_NAME}')` in the WORKSPACE.bzlmod file.") | ||
| return yes_or_no("Do you wish to retry the build after fixes?", True) |
There was a problem hiding this comment.
maybe remove the "after fixes" part since it can be slightly confusing
tools/migrate_to_bzlmod.py
Outdated
| return None, None | ||
|
|
||
|
|
||
| def address_unavailable_repo_error(repo, from_repo, resolved_deps): |
There was a problem hiding this comment.
the "from_repo" param no longer seems to be used.
There was a problem hiding this comment.
Done, I'm keeping it in the return value of detect_unavailable_repo_error just in case we need it later.
|
|
||
|
|
||
| # Create MODULE.bazel file if it doesn't exist already. | ||
| scratch_file("MODULE.bazel", [], mode="a") |
There was a problem hiding this comment.
maybe create these with the current workspace name? (or do you think it's better to let the user manually add a module name later on?)
There was a problem hiding this comment.
I think let the user be aware of this is better.
Wyverald
approved these changes
Mar 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The script does the following things:
dependencies with --experimental_repository_resolved_file
To start the migration, clone the Bazel central registry repo and run the following command from your project root: