about summary refs log tree commit diff
path: root/nixos/doc
diff options
context:
space:
mode:
authorBilly J Rhoades II <billy@ngrok.com>2022-04-13 08:14:53 -0700
committerBilly J Rhoades II <billy@ngrok.com>2022-06-13 14:53:58 -0700
commit8e97f29c01229c424c5ff115178c45fd0349748c (patch)
tree75e26cb84bc4e49fa3f7c581f8e3ab1a2f6e7df3 /nixos/doc
parent13f08d71ceff5101321e0291854495a1ec153a5e (diff)
ngrok: 2.3.40 -> 3.0.4
ngrok 3 was released this morning. Changelog from v2 is here:

https://ngrok.com/docs/ngrok-agent/changelog

And a detailed upgrade guide is here:

https://ngrok.com/docs/guides/upgrade-v2-v3

Notably, arguments must now be double hyphens: `--token`. Previously,
single hyphens were accepted but those invocations will now error.
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/from_md/release-notes/rl-2211.section.xml11
-rw-r--r--nixos/doc/manual/release-notes/rl-2211.section.md4
2 files changed, 15 insertions, 0 deletions
diff --git a/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml
index 79bba37a13589..c6eaf4624291e 100644
--- a/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml
+++ b/nixos/doc/manual/from_md/release-notes/rl-2211.section.xml
@@ -102,6 +102,17 @@
       </listitem>
       <listitem>
         <para>
+          <literal>ngrok</literal> has been upgraded from 2.3.40 to
+          3.0.4. Please see
+          <link xlink:href="https://ngrok.com/docs/guides/upgrade-v2-v3">the
+          upgrade guide</link> and
+          <link xlink:href="https://ngrok.com/docs/ngrok-agent/changelog">changelog</link>.
+          Notably, breaking changes are that the config file format has
+          changed and support for single hypen arguments was dropped.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
           The <literal>isPowerPC</literal> predicate, found on
           <literal>platform</literal> attrsets
           (<literal>hostPlatform</literal>,
diff --git a/nixos/doc/manual/release-notes/rl-2211.section.md b/nixos/doc/manual/release-notes/rl-2211.section.md
index 50bf15ca197d8..56df3c00cb200 100644
--- a/nixos/doc/manual/release-notes/rl-2211.section.md
+++ b/nixos/doc/manual/release-notes/rl-2211.section.md
@@ -45,6 +45,10 @@ In addition to numerous new and upgraded packages, this release has the followin
   `lib.systems.parse.isCompatible` still exists, but has changed semantically:
   Architectures with differing endianness modes are *no longer considered compatible*.
 
+- `ngrok` has been upgraded from 2.3.40 to 3.0.4. Please see [the upgrade guide](https://ngrok.com/docs/guides/upgrade-v2-v3)
+  and [changelog](https://ngrok.com/docs/ngrok-agent/changelog). Notably, breaking changes are that the config file format has
+  changed and support for single hypen arguments was dropped.
+
 - The `isPowerPC` predicate, found on `platform` attrsets (`hostPlatform`, `buildPlatform`, `targetPlatform`, etc) has been removed in order to reduce confusion.  The predicate was was defined such that it matches only the 32-bit big-endian members of the POWER/PowerPC family, despite having a name which would imply a broader set of systems.  If you were using this predicate, you can replace `foo.isPowerPC` with `(with foo; isPower && is32bit && isBigEndian)`.
 
 - PHP 7.4 is no longer supported due to upstream not supporting this