sudacode/SubMiner
1
0
Fork 0
mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-02-27 18:22:41 -08:00
Code Issues Packages Projects Releases Wiki Activity

ci: bundle config example in release assets

Browse Source
This commit is contained in:
Kyle Yasuda
2026-02-20 01:27:50 -08:00
parent a3569afdcf
commit ad2652b21a
7 changed files with 123 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
backlog/tasks/task-88 - Bundle-config-example-in-release-assets-artifact.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: TASK-88
title: Bundle config.example.jsonc in release assets artifact
status: Done
assignee: []
created_date: '2026-02-20 09:27'
updated_date: '2026-02-20 09:27'
labels: []
dependencies: []
priority: medium
ordinal: 70000
---
## Description
<!-- SECTION:DESCRIPTION:BEGIN -->
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.
<!-- SECTION:DESCRIPTION:END -->
## Acceptance Criteria
<!-- AC:BEGIN -->
- [x] #1 Release workflow includes `config.example.jsonc` in `subminer-assets-*.tar.gz`.
- [x] #2 Release notes optional-assets section includes config copy step.
- [x] #3 Installation docs show config copy from extracted release assets bundle.
<!-- AC:END -->
## Implementation Notes
<!-- SECTION:NOTES:BEGIN -->
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`.
<!-- SECTION:NOTES:END -->
## Final Summary
<!-- SECTION:FINAL_SUMMARY:BEGIN -->
`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.
<!-- SECTION:FINAL_SUMMARY:END -->