Document the S3 file structure

[mcurcio]

Pardon me if this plugin is not ready for public consumption...

As far as I can tell, dev pack alone does not produce the correct directory structure to sync with S3. The Heroku CLI does some extra magic to add channel folders. What is the proper way to make the magic happen? Ideally I suppose pack/publish should incorporate channels (somehow?), but I was hoping for an expert take on the roadmap here.

[jdx]

The directory structure should be compatible with the update plugin out of the box. The paths are defined (and overridable in package.json) here: https://github.com/oclif/config/blob/master/src/config.ts#L205-L221

The update plugin will also use these same paths so you can have any structure you like.

Yes, this should be documented but I'm not sure the best place for it. I feel adding it to the release section of the docs would be adding too much detail.

[jdx]

Also, the Heroku CLI uses these defaults so you should be getting exactly the same thing.

[mcurcio]

Thanks for the prompt response. How would one define a channel when running pack and/or publish?

[jdx]

you set the version to something like 1.0.0-beta and then the channel will be beta

[mcurcio]

Well that makes a lot of sense. I guess I was just overthinking it based on the Heroku CLI scripts.

[jdx]

Still, I don't think this is documented anywhere. I'll see if I can add that somewhere

[jdx]

thoughts? oclif/oclif.github.io@829f4ed

[mcurcio]

That looks great. I would suggest noting that the version change occurs in the package.json file (as opposed to, say, a command line flag).