Skip to content

fix: stop shipping dev artefacts in make package ZIP (#50)#52

Merged
eXeLearningProject merged 2 commits into
mainfrom
50-no-unnecessary-files-in-package
May 11, 2026
Merged

fix: stop shipping dev artefacts in make package ZIP (#50)#52
eXeLearningProject merged 2 commits into
mainfrom
50-no-unnecessary-files-in-package

Conversation

@erseco
Copy link
Copy Markdown
Collaborator

@erseco erseco commented May 9, 2026

Summary

Fixes #50.

.claude/, .omc/, .editor-version, .env.dist and the stray Windows NUL file were being copied into the release ZIP because they were not listed in .distignore. They are now excluded so make package RELEASE=X.Y.Z produces a clean distribution.

AGENTS.md also gains a Twin-plugin checks section that asks coding agents to verify whether the same bug reproduces on mod_exescorm and to open a sibling PR when it does — that is what motivated the parallel fix below.

What changed

  • .distignore: added .claude, .omc, .editor-version, .env.dist, NUL.
  • AGENTS.md: new Twin-plugin checks (mod_exeweb ↔ mod_exescorm) section under Packaging & Release.

Test plan

  • make package RELEASE=test produces mod_exeweb-test.zip; unzip -l shows no .claude, .omc, .editor-version, .env*, NUL, .distignore, or .git* entries.
  • The expected payload (amd/, classes/, lang/, dist/, lib.php, view.php, …) is still present and the ZIP installs cleanly via Moodle plugin install.

Sibling PR

Same fix on the SCORM side: exelearning/mod_exescorm#67 (issue exelearning/mod_exescorm#65).


Moodle Playground Preview

The changes in this pull request can be previewed and tested using a Moodle Playground instance.

Preview in Moodle Playground

⚠️ The embedded eXeLearning editor is not included in this preview. You can install it from Modules > eXeLearning Web > Configure using the "Download & Install Editor" button. All other module features (ELPX upload, viewer, preview) work normally.

`.claude`, `.omc`, `.editor-version`, `.env.dist` and the stray Windows
`NUL` file were being picked up by `make package` because they were not
listed in `.distignore`. Add them so they no longer end up in release
ZIPs.

Also document a `Twin-plugin checks` workflow in `AGENTS.md` requiring
cross-checks against the sibling `mod_exescorm` repository whenever a
fix is applied here.
@erseco erseco force-pushed the 50-no-unnecessary-files-in-package branch from df9a711 to b0a231c Compare May 9, 2026 15:44
@eXeLearningProject eXeLearningProject merged commit 76b1213 into main May 11, 2026
1 check passed
@eXeLearningProject eXeLearningProject deleted the 50-no-unnecessary-files-in-package branch May 11, 2026 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

No unnecessary files in the package

3 participants