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

docs: rules_python bzlmod GA and 1.0 prep #2296

Merged
merged 12 commits into from
Oct 21, 2024

Conversation

aignas
Copy link
Collaborator

@aignas aignas commented Oct 13, 2024

This is documenting the current state and closing the last remaining
TODO items for 1.0 release.

Work towards #1361.

@aignas
Copy link
Collaborator Author

aignas commented Oct 13, 2024

Ran out of time today and this may contain some omissions, feel free to push here and reword things.

BZLMOD_SUPPORT.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
SHA="84aec9e21cc56fbc7f1335035a71c850d1b9b5cc6ff497306f84cced9a769841"

VERSION="0.23.1"
# Update the snippet based on the latest release below
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: Are you sure about this change? I'm +1 on increasing to a newer version. Doesn't the extracted variables make it easier to bump versions in future? Or are you thinking there aren't major benefits to the indirection?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I am thinking that one needs to copy the sha and version separately instead of just replacing the whole block of http_archive. If we had the indirection in the releases page, then sure, I think we should keep it, but the releases page does not have that.

What do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh right. Yes. If we could prepare a full copy-paste snippet somewhere that is kept up to date automatically, that would be cool. Im fine with your change.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, the snippet is in the releases page, e.g. https://github.com/bazelbuild/rules_python/releases/tag/0.36.0

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@groodt groodt left a comment

Choose a reason for hiding this comment

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

LGTM

@aignas
Copy link
Collaborator Author

aignas commented Oct 15, 2024

@rickeylev, I'll leave this open for you to have a chance to take a look.

Copy link
Collaborator

@rickeylev rickeylev left a comment

Choose a reason for hiding this comment

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

Mostly LGTM. Only real issue I have is the phrasing of the pypi integration

BZLMOD_SUPPORT.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@aignas aignas requested a review from f0rmiga as a code owner October 16, 2024 05:51
@aignas aignas added this pull request to the merge queue Oct 21, 2024
Merged via the queue into bazelbuild:main with commit 317dab4 Oct 21, 2024
4 checks passed
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.

3 participants