Package Control Channel

repository·master·Indexed 23 days ago

https://github.com/sublimehq/package_control_channel

The source of truth for the Package Control Default Channel, containing metadata to make Sublime Text packages discoverable and installable. Includes utilities for maintaining the channel, such as format_package_control_channel.py for JSON styling and report_404_packages.py for identifying and removing broken package links.

Tokens
655
Snippets
1
Records
7
Agent score
29%

What's inside package_control_channel

  1. How the Package Control channel is constructed

    master

    The Package Control channel is built from source JSON files located in this repository. The files channel.json, repository.json, and the individual files within the repository/ directory contain the lists of repositories and packages.

    A crawler processes these source files and compiles them into a single master file: channel_v3.json (available at https://packagecontrol.io/channel_v3.json). This compiled file serves as the authoritative source for all packages available for installation via Package Control.

  2. Submit your package to the Package Control Default Channel

    master

    To make your Sublime Text package available for installation via Package Control, you must add its details to this repository. Follow these steps:

    1. Review the official submission guide.
    2. Fork this repository.
    3. Add your package details to the appropriate JSON file within the repository/ directory. Ensure entries are added in alphabetical order.
    4. Create a Pull Request (PR) and ensure you have addressed all requirements specified in the PR template.
  3. Report 404 packages in the crawler workspace

    master

    Use report_404_packages.py to identify packages in a crawler workspace.json that return a fatal: 404 error. By default, it reports packages that have failed for at least 21 days.

    Key Features

    • Workspace Loading: If --workspace is not provided, the tool attempts to download one from packagecontrol/thecrawl (requires gh).
    • Automated Removal: Using the --commit flag will remove the identified packages from the repository and create a commit.
    • Filtering: Use --ignore (for names or detail URLs) or --ignore-file to prevent recurring reports for known packages.
    • CI Integration: Use --build-pr-message to generate pr_title.txt and pr_body.md for automated Pull Requests.