Skip to content
This repository has been archived by the owner on Mar 1, 2022. It is now read-only.

skip_packman isn't a great config name #111

Closed
jmuk opened this issue Oct 13, 2016 · 10 comments
Closed

skip_packman isn't a great config name #111

jmuk opened this issue Oct 13, 2016 · 10 comments
Assignees
Labels

Comments

@jmuk
Copy link
Contributor

jmuk commented Oct 13, 2016

When a user writes their own artman configuration yaml, normally they will refer to existing file, and many of existing package yaml contains 'skip_packman' for Ruby and Node.

The problem is that nobody outside of our team would understand what packman is, therefore they will copy 'skip_packman: true' line unintentionally.

It's better to rename this.

@jmuk
Copy link
Contributor Author

jmuk commented Oct 13, 2016

cc: @geigerj @swcloud

@geigerj
Copy link
Contributor

geigerj commented Oct 13, 2016

Possible suggestions for renaming: package_metadata, standalone_package, package?

@jmuk
Copy link
Contributor Author

jmuk commented Oct 13, 2016

some random ideas: 'generate_package_files', 'source_only'

@jmuk
Copy link
Contributor Author

jmuk commented Oct 13, 2016

package_metadata might be good. I like it.

@jmuk
Copy link
Contributor Author

jmuk commented Oct 13, 2016

cc: @bjwatson too

@garrettjonesgoogle
Copy link
Member

@pongad added a new config field into the GAPIC yaml named domain_layer_location which I think could serve for this purpose. The real "data" is if there is a domain layer for the API; the skip_packman field is just a specific action that should be taken as a result. The challenge is that the config line is in GAPIC yaml instead of artman yaml. Over time, I think we will be encountering more configuration like this, where the language+API-specific information needs to be used both by the generator and also outside of the generator (in the artman process).

@swcloud
Copy link

swcloud commented Oct 13, 2016

There will be always arguments around names. :)

'domain_layer_location' sounds non-intuitive too if that's a configuration item exposed to a user.

@swcloud
Copy link

swcloud commented Oct 13, 2016

In this particular case, I'd prefer 'generate_package_metadata' since it explicitly indicates whether we want to generate package metadata or not.

@jmuk
Copy link
Contributor Author

jmuk commented Jan 20, 2017

Want to revisit this issue. Since parts of package generations are moving to toolkit, the name skip_packman does not make much sense.

@ethanbao
Copy link
Contributor

ethanbao commented Nov 1, 2017

The whole skip_packman has been deprecated in the new artman config syntax.

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

No branches or pull requests

6 participants