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

Extend README #21

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Extend README #21

wants to merge 1 commit into from

Conversation

sgasse
Copy link

@sgasse sgasse commented Aug 9, 2020

  • Add loading of http_archive rule.
  • Explicilty mention to replace commit hashes.

@chuckx
Copy link
Collaborator

chuckx commented Aug 9, 2020

This removes a necessary detail when dealing with release tags instead of commit hashes.

For example, take the latest release from the pybind repository (v2.5.0):

Naming the placeholder stable-version is meant to imply the use of a release tag, i.e. for version 2.5.0 use "v2.5.0" in the urls value and "2.5.0" in the strip-prefix value.

Perhaps a better approach would be to use a a generic name for the placeholder (e.g. version-identifier) and then provide a brief explanation to point out the details of using a release tag versus a commit hash.

Note that this distinction isn't necessary for this repository. Since there are no tagged releases (for now at least), commit hashes are the only option. Hence the placeholder being named stable-commit.

- Add loading of http_archive rule.
- Explicilty mention to replace version identifiers.
@sgasse
Copy link
Author

sgasse commented Aug 11, 2020

Ah thank you for explaining the difference, @chuckx ! I updated my changes accordingly. Would it make sense like this?

)
load("@pybind11_bazel//:python_configure.bzl", "python_configure")
python_configure(name = "local_config_python")
```

Replace `<version-identifier>` with the version you want to use.
- For `pybind11_bazel`, there are no tagged releases yet, so `<version-identifier>` has to be replaced with a full commit hash.
- For `pybind11`, you can either use a commit hash or a release tag like `v2.5.0`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This still glosses over the distinction necessary for the strip_prefix value (2.5.0) vs. the urls value (v2.5.0).

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.

None yet

2 participants