Skip to content

PUBLIC_RELEASE_REPO.md

Latest commit

 

History

History
126 lines (80 loc) · 2.97 KB

PUBLIC_RELEASE_REPO.md

File metadata and controls

126 lines (80 loc) · 2.97 KB
Raw

Public Release Repository

YTDownloader source code is private. Public downloads should be published from a separate binary-only repository:

JJDing-Louis/YTDownloader-Release

Recommended public download URL:

https://github.com/JJDing-Louis/YTDownloader-Release/releases

Repository Contents

The public release repository should not contain source code.

Recommended files:

  • README.md
  • LICENSE.md
  • PRIVACY.md
  • GitHub Releases containing:
    • YTDownloader_Setup_v<version>.exe
    • SHA256SUMS.txt

Templates are available in:

release-repo-template/

Required Secret

The private source repository needs a GitHub Actions secret for public release publishing:

RELEASE_REPO_TOKEN

This token must have permission to create releases and upload assets in:

JJDing-Louis/YTDownloader-Release

Use a fine-grained personal access token with access only to the public release repository when possible. Required repository permissions:

  • Contents: Read and write
  • Metadata: Read

Required NuGet Package Secret

The private source repository also needs a GitHub Actions secret for restoring private GitHub Packages:

GH_PACKAGES_TOKEN

Use a personal access token classic with:

read:packages

The workflow uses this token to add:

https://nuget.pkg.github.com/JJDing-Louis/index.json

as a NuGet source before running dotnet restore.

Publish Flow

  1. Create or update the private source repository.
  2. Push a release tag from the private source repository:
git tag Release-1.0.0
git push origin Release-1.0.0
  1. The private repository workflow builds the installer.
  2. The workflow publishes release assets to the public release repository with GitHub CLI.
  3. The workflow verifies the release exists in the public release repository before finishing.

Public Release Repo README Template

Use this in JJDing-Louis/YTDownloader-Release/README.md:

# YTDownloader

YTDownloader is a Windows desktop application for downloading video and audio media and managing download tasks and download history.

## Download

Download the latest installer from GitHub Releases:

https://github.com/JJDing-Louis/YTDownloader-Release/releases/latest

Each release includes:

- `YTDownloader_Setup_v<version>.exe`
- `SHA256SUMS.txt`

## Verify Installer

```powershell
Get-FileHash .\YTDownloader_Setup_v<version>.exe -Algorithm SHA256

Compare the output with SHA256SUMS.txt.

License

YTDownloader is distributed under the YTDownloader End User License Agreement. You may install and use the official application for personal, learning, backup, and other non-commercial purposes.

Commercial use, redistribution, product bundling, paid packaging, and commercial service use are not permitted. No commercial license is offered.

Privacy

YTDownloader runs locally and does not intentionally include telemetry, analytics, tracking pixels, advertising identifiers, or behavior tracking.