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

buildkite-agent: rename option meta-data to tags #46120

Closed
wants to merge 1 commit into from

Conversation

mkaito
Copy link
Contributor

@mkaito mkaito commented Sep 5, 2018

Motivation for this change

According to upstream changes

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Fits CONTRIBUTING.md.

@@ -219,7 +219,7 @@ in
cat > "${cfg.dataDir}/buildkite-agent.cfg" <<EOF
token="$(cat ${toString cfg.tokenPath})"
name="${cfg.name}"
meta-data="${cfg.meta-data}"
tags="${cfg.tags}"
Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like this change was introduced in https://github.com/buildkite/agent/blob/master/CHANGELOG.md#added-18

The default version the module uses is 2.6.1. Will this not fail given tags instead of meta-data?

A solution would be to either support both or at the very least change the default and assert that the version is in fact above 3.0-beta.22

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Seems like unnecessary complication to me. Do we really need to support 2.6.1 given that 3.0 has been stable for months? At work we found that <3.0 in nixpkgs didn't even work correctly, and required patches to run at all.

Copy link
Contributor

Choose a reason for hiding this comment

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

What would you suggest instead? In the current state of this PR, enabling the agent would simply fail unless the package is overwritten.

As I said in my second option, I think it's fine to make this module incompatible with earlier versions, but then it should in fact be made incompatible with earlier versions. At the very least, the default package should change, and a release note would be great, if relevant. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Alright, I agree that if both versions are present and available in nixpkgs, both should be usable by the available service module. I was postulating we should deprecate the older version, but I'm not sure I should be doing that in this PR. Which makes this PR kinda pointless. I'll try to submit a new PR that addresses my position correctly.

@mkaito mkaito closed this Sep 10, 2018
@mkaito mkaito deleted the bk-agent-tags branch September 10, 2018 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants