nixos/buildkite-agents: update release notes

This commit is contained in:
Yorick van Pelt 2020-01-24 19:31:33 +01:00
parent f003810989
commit e242eccb0b
No known key found for this signature in database
GPG key ID: A36E70F9DC014A15
2 changed files with 11 additions and 7 deletions

View file

@ -440,15 +440,19 @@ users.users.me =
</listitem>
<listitem>
<para>
The <link linkend="opt-services.buildkite-agent.enable">Buildkite Agent</link>
module and corresponding packages have been updated to 3.x.
While doing so, the following options have been changed:
The <link linkend="opt-services.buildkite-agents">Buildkite
Agent</link> module and corresponding packages have been updated to
3.x, and to support multiple instances of the agent running at the
same time. This means you will have to rename
<literal>services.buildkite-agent</literal> to
<literal>services.buildkite-agents.&lt;name&gt;</literal>. Furthermore,
the following options have been changed:
</para>
<itemizedlist>
<listitem>
<para>
<literal>services.buildkite-agent.meta-data</literal> has been renamed to
<link linkend="opt-services.buildkite-agent.tags">services.buildkite-agent.tags</link>,
<link linkend="opt-services.buildkite-agents">services.buildkite-agents.&lt;name&gt;.tags</link>,
to match upstreams naming for 3.x.
Its type has also changed - it now accepts an attrset of strings.
</para>
@ -464,13 +468,13 @@ users.users.me =
<para>
<literal>services.buildkite-agent.openssh.privateKeyPath</literal>
has been renamed to
<link linkend="opt-services.buildkite-agent.privateSshKeyPath">buildkite-agent.privateSshKeyPath</link>,
<link linkend="opt-services.buildkite-agents">buildkite-agents.&lt;name&gt;.privateSshKeyPath</link>,
as the whole <literal>openssh</literal> now only contained that single option.
</para>
</listitem>
<listitem>
<para>
<link linkend="opt-services.buildkite-agent.shell">services.buildkite-agent.shell</link>
<link linkend="opt-services.buildkite-agents">services.buildkite-agents.&lt;name&gt;.shell</link>
has been introduced, allowing to specify a custom shell to be used.
</para>
</listitem>

View file

@ -267,6 +267,6 @@ in
]);
imports = [
(mkRemovedOptionModule [ "services" "buildkite-agent"] "services.buildkite-agent has been moved to an attribute set at services.buildkite-agents")
(mkRemovedOptionModule [ "services" "buildkite-agent"] "services.buildkite-agent has been upgraded from version 2 to version 3 and moved to an attribute set at services.buildkite-agents. Please consult the 20.03 release notes for more information.")
];
}