league-of-foundry-developers / foundryvtt-module-template Goto Github PK

When automatically creating the new release, the actions remove all quotation marks from module.json. Both in the Zip and outside.

The URL rewriting on lines 98-100 of https://github.com/League-of-Foundry-Developers/FoundryVTT-Module-Template/blob/master/.github/workflows/main.yml#L98-L100 say:

URL: ${{ $env.project_url }}
MANIFEST: ${{ $env.latest_manifest_url }}
DOWNLOAD: ${{ $env.release_module_url }}

which is not correct and results in a failure to execute the action. removing the $ before env works:

URL: ${{ env.project_url }}
MANIFEST: ${{ env.latest_manifest_url }}
DOWNLOAD: ${{ env.release_module_url }}

Currently, the CI/CD will automatically load the version from the manifest.json for creating the release and zip files, but users often forget to update the download URL, causing releases to break.

The Github Actions workflow should be updated to automatically update that URL to prevent this issue

The League's template instructions show how to create a release. GitHub offers 'common practice' instructions to create release tags, which suggests adding a v as a prefix to the tag version. See below:

This leads to problems because:

1. the release action strips the v from the version and puts the result in the module.json. ex: v1.0 tag becomes 1.0 in the module.json
2. there are no instructions for developers stating that the v should not be entered into the Foundry package submission form. The tag where they copy the module.json url still has the v. ex: v1.0
3. once released in Foundry with a v in the version number, there is a mismatch between what Foundry thinks the version is and what the module.json says the version is. This results in constant prompts to the end users to update their modules.

I have personally been faced with this issue, and I have also seen others deal with this as well. It is inconvenient because removing the v is the solution, but because of how Foundry works, the developer has to inform the end users to first uninstall and then reinstall with the new version because vX.X will always be bigger/newer than X.X (where X's are numbers), so it's not possible for Foundry to offer the new version without the v as the newest version.

The template itself has a "languages" folder.
The .github/workflows/main.yml on line 126 mentiones a "language" (missing the "s")folder and if used that way will result in an error.

I have no idea how issues work and what they are meant for, but it seemed to me the most direct way to communicate that. Apologies for any inconveniences.

See title

Edit: GNU gives some reasoning for why this is necessary. Note: they also say "just including a file without a notice at the top of every source file isn't good enough," though it seems good enough for lots of companies with lawyers. https://www.gnu.org/licenses/gpl-faq.html#WhyMustIInclude

Examples of FOSS orgs that require distributing the license file with the software:

• https://www.apache.org/legal/release-policy.html#licensing-documentation
• https://packaging.python.org/guides/distributing-packages-using-setuptools/#license-txt