Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow configuring the tarball path & filename templates #828

Open
pimterry opened this issue Feb 12, 2022 · 4 comments
Open

Allow configuring the tarball path & filename templates #828

pimterry opened this issue Feb 12, 2022 · 4 comments
Labels

Comments

@pimterry
Copy link
Contributor

Do you want to request a feature or report a bug?

Feature

What is the current behavior?

In @oclif/dev-cli, the tarball template format was configurable in package.json under ``update.s3.templates`.

When upgrading to oclif this config no longer works, and it looks like the template format is now hardcoded (here).

This makes it almost impossible to support alternative tarball hosting such as Azure (#316) or GitHub releases. Even with custom code to do the uploading, the subdirectory struture isn't possible to replicate on all possible hosts. To make this work for GitHub releases, I'd need to build all the tarballs, and then manually rename every manifest and modify all the URLs within the manifests, which doesn't feel like a good idea.

This is now blocking me from upgrading from @oclif/dev-cli because I have users in production that currently pull updates from GitHub releases (built using this configuration) and I can't easily deploy new releases to GitHub releases with oclif that will work with that existing update mechanism.

What is the expected behavior?

It should be possible to provide template configuration, overriding those hardcoded values, which would make it possible to easily deploy to non-S3 tarball hosts.

I'm happy to make a PR to do this (it looks very quick & easy, just using the config values here), but I'm interested to know:

  • Is there a good reason this isn't possible already?
  • If I opened a PR for this, would it be accepted?
@aaronlippold
Copy link

i would be happy to support a PR

@pitoniak32
Copy link

could I take a stab at implementing this? I am in the process of upgrading our team cli from oclif-v1 to oclif-v2, and this would be a nice feature to keep our existing release pipelines working.

@pimterry
Copy link
Contributor Author

could I take a stab at implementing this?

I can't speak for the maintainers (look like @mdonnalley is the person to talk to) but as a user I still have issues due to this, and I haven't got around to trying to fix it myself, so if you have time I'd certainly appreciate it!

@mdonnalley
Copy link
Contributor

We'd love a PR for this if anyone is up to the task - otherwise, I'm not sure when this will rise to the top of our backlog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants