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

Host JS package bzlmod-version #83

Open
hobofan opened this issue Aug 18, 2023 · 1 comment
Open

Host JS package bzlmod-version #83

hobofan opened this issue Aug 18, 2023 · 1 comment

Comments

@hobofan
Copy link
Member

hobofan commented Aug 18, 2023

I've recently (with permission of @cgrindel) extracted his work on renovate, where he established proper support for the bzlmod version format into a separate project: https://github.com/hobofan/bzlmod-version, with the goal of making it available for more projects (e.g. bcr-ui to resolve bazel-contrib/bcr-ui#54).

I'd like to transfer the project to the bazel-contrib org, so that it's hosted in a proper neutral place.

There are still a few open issues in the adding criteria list below, which I'm looking to resolve before the project will be transfered, but I wanted to open the issue early to get some opinons on whether the project would be a fit for hosting under the organization.

Apart from that there is one semi-bikeshedding open question: The current presumed NPM package name I've chosen is @bazel/bzlmod-version. However from a recent SIG meeting it seems like the SIG only indirectly has access to the @bazel namespace. Should we open up a @bazel-contrib namespace and adjust the package name accordingly?


List from https://bazel-contrib.github.io/SIG-rules-authors/hosting-policy.html#adding-criteria (will update):

Must use an open-source license, preferably Apache-2.0.

✅ (Renovate uses AGPL, but @cgrindel agreed to relicense)

Must have wide applicability in the community.

"Wide" is debatable, but at least bcr-ui and the renovate integration would benefit from having it as a shared codebase, and other future JS/TS projects in the bzlmod space would benefit from it.

Must have a clear point of contact who answers questions from the SIG.

That would be me and hopefully @cgrindel as backup.

Must be “production quality”:
clear README or other documentation outlining the goal of these rules, how to use them etc.

✅ (I hope, to be refined with usage examples)

generated API documentation

🚧 TODO

include examples of use

🚧 TODO

tests that are running continuously

✅ Both JS tests as well as the Bazel build of the package are tested via GH Actions

Must reply to issues/PRs in 2-3 weeks (exact service level agreement TBD)

Sounds doable

Must have more than one person who is committed to review/approve PRs

That would again be me, and hopefully @cgrindel

Must publish semver releases.

Must work with LTS Bazel version

n/a

@cgrindel
Copy link
Member

I am willing to be a maintainer on the repository. Thanks for doing this work, @hobofan.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants