Skip to content

README.md

Latest commit

 

History

History
77 lines (62 loc) · 2.77 KB

README.md

File metadata and controls

77 lines (62 loc) · 2.77 KB

LizardByte Package Repository

This repository serves as a centralized package index and filtered release asset mirror for repositories within the LizardByte organization. Release metadata is published to GitHub Pages, while configured assets are also downloaded and organized in the dist branch for direct access and distribution.

Structure

The repository is organized as follows:

dist/
├── repo-name-1/
│   ├── v1.0.0/
│   │   ├── asset1.zip
│   │   ├── asset1.zip.sha256
│   │   ├── asset1.zip.sha512
│   │   ├── asset1.zip.md5
│   │   └── ...
│   └── v1.1.0/
│       └── ...
├── repo-name-2/
│   └── ...
└── ...

Features

  • Automated Collection: GitHub Actions workflow automatically downloads release assets from all org repos
  • Hash Validation: Each asset includes SHA256, SHA512, and MD5 hash files for integrity verification
  • Organized Structure: Assets are organized by repository name and release tag
  • Incremental Updates: Only new assets are downloaded to avoid duplication
  • Scheduled Updates: Runs every hour to keep assets up-to-date

Workflow

The release asset collection and GitHub Pages deployment are handled by the update-pages.yml workflow. Asset retention is controlled by packages.config.json.

  1. Discovers all repositories in the LizardByte organization
  2. Fetches release information for each repository
  3. Downloads configured release assets
  4. Removes previously stored assets that are no longer configured
  5. Generates hash files for integrity verification
  6. Writes packages.json with release and asset links for GitHub Pages
  7. Amends the current dist branch commit and force-pushes it
  8. Rebuilds GitHub Pages and publishes the filtered dist assets there too

Configuration

packages.config.json controls which release assets are retained in dist and get direct GitHub Pages links. packages.json is generated from GitHub release metadata for all discovered assets. Every asset gets a GitHub Releases download URL, and mirrored assets also get a direct GitHub Pages URL. defaultInclude is false, so repositories must opt in with asset patterns for files that should be mirrored.

{
  "defaultInclude": false,
  "repositories": {
    "Sunshine": {
      "includeAssets": [
        "*-installer.exe",
        "*-installer.msi"
      ]
    }
  }
}

Usage

Configured release assets are available in the dist branch of this repository. You can:

  • Browse the GitHub Pages package index for per-release asset links
  • Use GitHub Releases URLs for every release asset
  • Use GitHub Pages direct URLs for mirrored assets, e.g. /packages/<repo>/<tag>/<asset>
  • Use the hash files beside mirrored assets to verify asset integrity