Files
SubMiner/backlog/tasks/task-88 - Bundle-config-example-in-release-assets-artifact.md

1.4 KiB

id, title, status, assignee, created_date, updated_date, labels, dependencies, priority, ordinal
id title status assignee created_date updated_date labels dependencies priority ordinal
TASK-88 Bundle config.example.jsonc in release assets artifact Done
2026-02-20 09:27 2026-02-20 09:27
medium 70000

Description

Release users should get a version-matched config.example.jsonc without cloning the repo. Include the file in subminer-assets-*.tar.gz and align install snippets/docs.

Acceptance Criteria

  • #1 Release workflow includes config.example.jsonc in subminer-assets-*.tar.gz.
  • #2 Release notes optional-assets section includes config copy step.
  • #3 Installation docs show config copy from extracted release assets bundle.

Implementation Notes

Updated .github/workflows/release.yml optional assets packaging to include config.example.jsonc, and updated release body instructions accordingly. Updated docs/installation.md and docs/mpv-plugin.md release-bundle install snippets to copy /tmp/config.example.jsonc into ~/.config/SubMiner/config.jsonc.

Final Summary

config.example.jsonc is now bundled in the release subminer-assets-*.tar.gz artifact, with release/install docs aligned so users can copy it directly after extracting the bundle.