Skip to content

Conversation

@francoiscampbell
Copy link
Contributor

@francoiscampbell francoiscampbell commented Oct 12, 2023

By default this plugin collects the run output in a +++ group, while the docker plugin collects it in a --- group (https://github.com/buildkite-plugins/docker-buildkite-plugin/blob/36b85cc317745f868f2f6918a02f9cfb6a0b3069/commands/run.sh#L503). This PR unifies the two plugins by switching to using --- by default.

The rationale for using --- by default is that when we're passing lots of environment variables, volumes, etc, the docker-compose run ... command gets pretty long and having the log group expanded by default is noisy. Additionally, it's quite likely that the command being run will create a +++ group of its own, so it's not necessary for the plugin to provide one by default.

For backwards compatibility, the collapse-run-log-group option has been added, which will restore the old behaviour.

@francoiscampbell francoiscampbell changed the title Collapse logging of run args by default Collapse logging of run output by default Oct 12, 2023
Copy link
Contributor

@pzeballos pzeballos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @francoiscampbell! I think this is reasonable, but you are changing the default behavior, if the default kept the current functionality will be ok to merge (and update the test 🙂 )

@francoiscampbell
Copy link
Contributor Author

Ok @pzeballos, I've flipped the default. Are we OK with the default being inconsistent between this plugin and the Docker one?

@pzeballos
Copy link
Contributor

Ok @pzeballos, I've flipped the default. Are we OK with the default being inconsistent between this plugin and the Docker one?

yep, all good, they are different plugins, and we prefer not to do a backwards compatibility change at the moment :)

The build is failing in the linter step @francoiscampbell , can you update the Readme to use v4.15.0? Thanks!

@francoiscampbell
Copy link
Contributor Author

Updated

@pzeballos pzeballos self-requested a review October 23, 2023 18:30
Copy link
Contributor

@pzeballos pzeballos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pzeballos pzeballos merged commit eb55f0b into buildkite-plugins:master Oct 23, 2023
@francoiscampbell francoiscampbell deleted the collapse-args branch October 27, 2023 15:16
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

Successfully merging this pull request may close these issues.

2 participants