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

Better configuration option #187

Open
Andre601 opened this issue Sep 29, 2024 · 3 comments
Open

Better configuration option #187

Andre601 opened this issue Sep 29, 2024 · 3 comments

Comments

@Andre601
Copy link

Having to create and edit a TS file feels kinda weird, even if you have a little experience with TS itself.

Instead of having such a file should the config options be defined in a different format, like JSON or YAML, to be a bit more userfriendly.

Additionally should it be configurable, where the file is located (if that isn't a thing already), to allow maintainers the freedom of organizing their repository the way they like to have (i.e. by putting the config in the .github folder).

@anbraten
Copy link
Member

anbraten commented Sep 30, 2024

Honestly json or typescript is pretty similar 🤔 As you can not write hooks easily in json / yaml those aren't really an option TBF:

getNextVersion: (ctx: HookContext) => PromiseOrValue<string>;

Quite a few options can be set using env variables / plugin settings: https://github.com/woodpecker-ci/plugin-ready-release-go/blob/main/docs.md#settings

@Andre601
Copy link
Author

I personally dislike that the docs.md isn't explaining all the settings. Only a few (in regards to the config ts file) and then expects the user to know how to read the TS file and how it should be formatted...
Granted, one can assume that someone using Woodpecker may be familiar with such stuff, but it's also not a guarantee either.

What I want to say is, that a bit more verbose explanation would be of great use for the more average user. Maybe a sort of cookbook page could be useful here, listing some examples?

@Andre601
Copy link
Author

Also, at the very least should it be made possible to allow setting your own location for the config file, no?
Or alternatively have some options be added to the plugin settings, like the commentOnReleasedPullRequests option (Maybe as a PLUGIN_COMMENT_ON_RELEASE_PRS env variable?).

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

No branches or pull requests

2 participants