Can the pkg folder in built .tgz be renamed?

[jswalden]

The manual installation instructions I have to provide for module releases currently instruct people to download a .tar.gz file, then extract it into a companion-module-dev/ folder they've created to hold a manually installed module. I then have to explicitly say that the resulting pkg directory can be renamed, if they in fact have more than one locally installed module. It would be nice if the generated pkg.tgz's top-level folder were reasonably distinctly named so that this extra rename step every time isn't necessary.

(I concede that in the 4.0 era shortly upon us, this concern is substantially vitiated.)

These two revs implement this change.

The first is a minor refactor that eliminates repeated mention of pkg everywhere, instead using path.join with a variable that refers to the pkg directory. I think you can, and should, just take this immediately, no fuss or muss -- regardless whether this issue is worth fixing. It doesn't change anything about the resulting package. But it does meaningfully reduce repetition of the "pkg" magic string, which makes the script cleaner code.

The second changes from generating files into pkg/ and packaging that up, to generating into pkg/${moduleName} and packaging that up. It works exactly fine to implement the change I desire here. However, it looks like this would plainly break (at minimum -- maybe there's more than this that it breaks?) the bundled-modules update workflow -- even as that workflow seems like it would probably prefer for the pkg folder to be named something different (and possibly even what this change would make it be named).

Anyway. At this point, I think need some feedback about whether there is any interest in part 2 of this, and whether there are any other places that would require changes to deal with a non-pkg-named directory besides that script, before I proceed any further here. 🙂

[Julusian]

It looks like I wrote the code inside companion to handle the root folder being on an unknown same, so I think this would be fine to do

[Julusian]

This will break some of the workflow in https://github.com/bitfocus/companion-bundled-modules/blob/main/.github/workflows/portal-update-module.yml, but I have been trying to remove that portion for a little while now, so I am not worried