Skip to content

Rename canonical workspace name to "@rules_python" #212

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

Merged
merged 2 commits into from
Jul 27, 2019

Conversation

brandjon
Copy link
Contributor

Fixes #203.

This includes regenerating the par files to use the new name. Neat trick: Since
the par file regeneration depends on the previous par files, I had to bootstrap
this change by temporarily editing the WORKSPACE to include:

local_repository(
    name = "io_bazel_rules_python",
    path = ".",
)
@brandjon brandjon requested a review from c-parsons July 26, 2019 20:45
This hooks into pip_repositories(), which users are *supposed* to be calling in
their WORKSPACE files, to emit a nice fail() message alerting them that they
need to update their repo definition.

Without this change (and even with it, for users who do not call
`pip_repositories()`), users will instead see a confusing cyclic dependency
error.
@@ -4,6 +4,10 @@ Status: This is **ALPHA** software.

[![Build status](https://badge.buildkite.com/0bcfe58b6f5741aacb09b12485969ba7a1205955a45b53e854.svg)](https://buildkite.com/bazel/python-rules-python-postsubmit)

## Recent updates

Choose a reason for hiding this comment

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

I'm often a little unclear on whether README.md refers to the most recent release of the repository (and thus should only be updated alongside cutting a new release) or whether it affects state at HEAD. I leave it up to you -- just wanted to make sure you've thought about its role in the release process of rules_python :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. I don't feel too bad about it being HEAD given that this repo doesn't even have any tags, but I don't know what a general solution would be. Aside from not iterating so quickly on the API. :)

@brandjon brandjon merged commit d1596a3 into bazel-contrib:master Jul 27, 2019
@brandjon brandjon deleted the rename branch July 27, 2019 03:14
fweikert pushed a commit to fweikert/rules_python that referenced this pull request Aug 7, 2019
* Change official workspace name to @rules_python

This includes regenerating the par files to use the new name. Neat trick: Since
the par file regeneration depends on the previous par files, I had to bootstrap
this change by temporarily editing the WORKSPACE to include:

local_repository(
    name = "io_bazel_rules_python",
    path = ".",
)

* Add a nice error message to help with the workspace name migration

This hooks into pip_repositories(), which users are *supposed* to be calling in
their WORKSPACE files, to emit a nice fail() message alerting them that they
need to update their repo definition.

Without this change (and even with it, for users who do not call
`pip_repositories()`), users will instead see a confusing cyclic dependency
error.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename canonical workspace to @rules_python
3 participants