Skip to content

fix: stop shipping dev artefacts in make package ZIP (#65)#67

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

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

Conversation

@erseco
Copy link
Copy Markdown
Collaborator

@erseco erseco commented May 9, 2026

Summary

Fixes #65.

.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. The empty , artefact that had been accidentally committed at the repo root has also been removed.

A new AGENTS.md is added with a Twin-plugin checks section that asks coding agents to verify whether the same bug reproduces on mod_exeweb 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.
  • Removed the stray , file from the repo root (was tracked by accident).
  • AGENTS.md: new file mirroring the structure used in mod_exeweb, including the Twin-plugin checks (mod_exescorm ↔ mod_exeweb) section.

Test plan

  • make package RELEASE=test produces mod_exescorm-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 eXeWeb side: exelearning/mod_exeweb#52 (issue exelearning/mod_exeweb#50).


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 SCORM > 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. The empty `,` artefact accidentally tracked at the repo root has
also been deleted.

Also add an `AGENTS.md` documenting a `Twin-plugin checks` workflow that
requires cross-checks against the sibling `mod_exeweb` repository
whenever a fix is applied here.
@erseco erseco force-pushed the 65-no-unnecessary-files-in-package branch from 3a1bb08 to e4ce4bf Compare May 9, 2026 15:44
@erseco erseco requested a review from ignaciogros May 9, 2026 15:49
@erseco erseco self-assigned this May 9, 2026
@eXeLearningProject eXeLearningProject merged commit 40d7c99 into main May 11, 2026
1 check passed
@eXeLearningProject eXeLearningProject deleted the 65-no-unnecessary-files-in-package branch May 11, 2026 07:48
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