Skip to content

README update#97

Open
skeletonkey wants to merge 1 commit intobazel-contrib:mainfrom
skeletonkey:doc_updates
Open

README update#97
skeletonkey wants to merge 1 commit intobazel-contrib:mainfrom
skeletonkey:doc_updates

Conversation

@skeletonkey
Copy link
Collaborator

No description provided.

@skeletonkey skeletonkey requested a review from Copilot December 31, 2025 13:37
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the README to modernize the getting started instructions and provide comprehensive documentation for rules_perl. The changes add Bzlmod support alongside legacy WORKSPACE instructions and expand the documentation significantly.

Key Changes:

  • Added Bzlmod (MODULE.bazel) setup instructions as the recommended approach
  • Expanded platform support section with detailed compatibility information
  • Added complete reference documentation for all available rules (perl_binary, perl_library, perl_test, perl_xs)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@skeletonkey
Copy link
Collaborator Author

@UebelAndre @nigelgbanks @simeonwarren - if you guys have time, I'd appreciate a review of the README update.

bazel_dep(name = "rules_perl", version = "0.1.0") # Use appropriate version

# Register toolchains
perl = use_extension("@rules_perl//perl:extensions.bzl", "perl")
Copy link

@simeonwarren simeonwarren Dec 31, 2025

Choose a reason for hiding this comment

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

That doesn't seem right

  • There is no such extension
  • You cannot register toolchains using extensions if I remember correctly (that's false)

To register toolchains you just need to use register_toolchains("@rules_perl//perl:all")

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this would make sense to have though. Most rules use this pattern to define toolchains so it's understandable that was the assumption here.

Choose a reason for hiding this comment

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

The problem is that it's not correct - current rules do not work like that


**Attributes:**

| Attribute | Type | Description | Default |

Choose a reason for hiding this comment

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

Did you write it manually?

You can generate API documentation using stardoc, it's a pretty good tool

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 used AI to speed things along and it shows. I'll check that out - Thanks

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