Fix: metadata#11
Conversation
- Add `archive_name` to `mcdreforged.plugin.json` - Include `__main__.py` and `LICENSE` in resource list
- Add `archive_name` to `mcdreforged.plugin.json` - Include `__main__.py` and `LICENSE` in resource list
# Conflicts: # mcdreforged.plugin.json
There was a problem hiding this comment.
Pull request overview
This PR updates the plugin’s packaging metadata and the GitHub Actions release workflow to reflect a shift from .mcdr release artifacts to .pyz archives.
Changes:
- Add
archive_nametomcdreforged.plugin.jsonto name the packaged artifact as a.pyz. - Expand
resourcesinmcdreforged.plugin.jsonto include__main__.pyandLICENSE. - Update the release workflow to publish
.pyzfiles and include the version in the release name.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
mcdreforged.plugin.json |
Adds .pyz archive naming and includes additional packaged resources. |
.github/workflows/test.yml |
Changes release step to publish .pyz artifacts and sets a versioned release name. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| tag_name: ${{ startsWith(github.ref, 'refs/tags/v') && github.ref_name || format('v{0}', env.VERSION) }} | ||
| files: package/*.mcdr | ||
| name: Sakura Flow ${{ env.VERSION }} | ||
| files: package/*.pyz |
There was a problem hiding this comment.
The release job now attaches package/*.pyz, but the build job still uploads package/*.mcdr as the artifact. That means the downloaded artifact directory likely won’t contain any .pyz files and the release step will publish nothing or fail. Update the build job’s upload-artifact path (and any related expectations) to package/*.pyz (or keep the release step on .mcdr) so both stages agree on the artifact extension.
| files: package/*.pyz | |
| files: package/*.mcdr |
- Update artifact path pattern from `*.mcdr` to `*.pyz` in build workflow to match the generated package extension defined in `mcdreforged.plugin.json`
This pull request updates the release workflow and plugin metadata to align with recent packaging changes, ensuring that the correct files are included in releases and that metadata accurately reflects the new archive format.
Release workflow updates:
.github/workflows/test.ymlto use.pyzfiles instead of.mcdrfiles for release artifacts, and updated the release name to include the version.Plugin metadata updates:
archive_namefield tomcdreforged.plugin.jsonto specify the new.pyzarchive format.resourceslist inmcdreforged.plugin.jsonto include__main__.pyandLICENSEfiles.