Skip to content

docs(submitting): add how to use pkg review tool - #152

Open
vwheeler63 wants to merge 2 commits into
sublimetext-io:masterfrom
vwheeler63:feature/add_how_to_use_pkg_review_tool
Open

docs(submitting): add how to use pkg review tool#152
vwheeler63 wants to merge 2 commits into
sublimetext-io:masterfrom
vwheeler63:feature/add_how_to_use_pkg_review_tool

Conversation

@vwheeler63

Copy link
Copy Markdown
Contributor

Fixes: #151

This addresses the omission spelled out in #151, enabling package developers to do a better review of their own work before submitting new packages as PRs.

...Package developers can review their own packages before
they get to the stage of being a PR.  This somewhat replaces
the now-outdated presence of Step 7 in the old Package
submission guidance which advised installing
`ChannelRepositoryTools` Package and run its command
and ensure they passed before submitting Packages.
@vwheeler63 vwheeler63 changed the title feat(submitting): add how to use pkg review tool docs(submitting): add how to use pkg review tool Apr 8, 2026
@michaelblyons

Copy link
Copy Markdown
Contributor

Also available as a GitHub Action for reviewing a single package.

@vwheeler63

vwheeler63 commented May 7, 2026

Copy link
Copy Markdown
Contributor Author

Also available as a GitHub Action for reviewing a single package.

Hi, Michael! ( @michaelblyons )

I saw in the code how it is geared towards running in an environment like package_control_channel where it looks at the diffs of the "repository.json" files (e.g. m.json) and traces down the originating repository, clones that remote repository, and then reviews it in its "runner" space. Are you aware whether it can be used as a GitHub Action in, for example, my own Package repository? I looked around at a few high-end Package repositories (e.g. PackageControl, PackageDev and LSP) and didn't see it set up to run there as a GitHub Action. Are you aware of any examples?

Kind regards,
Vic

@michaelblyons

Copy link
Copy Markdown
Contributor

Are you aware whether it can be used as a GitHub Action in, for example, my own Package repository?

It can do both.

  • The gh_action folder does a test for a repository's changes and reviews all new and modified packages.
  • The gh_action_package I cited above reviews just a single package in the same way that your CLI samples would locally.

Are you aware of any examples?

I added an example to GitLink this week. For the moment, I have mine set only to run manually, but you could ask it to check PRs or whatever.

@vwheeler63

Copy link
Copy Markdown
Contributor Author

It can do both.

Very slick!! Thank you!

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.

Something is Missing in Package-Submission Guidelines

2 participants