docs(changelog): remove enable attr (#7458)

Idiomatic React is to conditionally render the entire element instead of
passing down an `enable` attribute.
This commit is contained in:
Thomas Eizinger
2024-12-05 00:08:33 +00:00
committed by GitHub
parent cf9573faa1
commit 2f2ad2cffe
2 changed files with 114 additions and 80 deletions

View File

@@ -2,18 +2,12 @@ import Entry from "./Entry";
import Link from "next/link";
export default function ChangeItem({
enable = true,
pull,
children,
}: {
enable?: boolean;
pull?: string;
children: React.ReactNode;
}) {
if (!enable) {
return null;
}
return (
<li className="pl-2">
{pull ? (

View File

@@ -46,36 +46,46 @@ export default function GUI({ title }: { title: string }) {
</Entry>
<Entry version="1.3.10" date={new Date("2024-10-31")}>
<ChangeItem>Handles DNS queries over TCP correctly.</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="7009">
The IPC service `firezone-client-ipc.exe` is now signed.
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="7009">
The IPC service `firezone-client-ipc.exe` is now signed.
</ChangeItem>
)}
<ChangeItem pull="7123">
Reports the version to the Portal correctly.
</ChangeItem>
<ChangeItem pull="6996" enable={title === "Linux GUI"}>
Supports Ubuntu 24.04, no longer supports Ubuntu 20.04.
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem pull="6996">
Supports Ubuntu 24.04, no longer supports Ubuntu 20.04.
</ChangeItem>
)}
<ChangeItem pull="7164">
Fixes an issue where Firezone would fail to establish connections to
Gateways and the user had to sign-out and in again.
</ChangeItem>
</Entry>
<Entry version="1.3.9" date={new Date("2024-10-09")}>
<ChangeItem enable={title === "Linux GUI"} pull="6987">
Fixes a crash on startup caused by incorrect permissions on the ID
file.
</ChangeItem>
<ChangeItem enable={title === "Windows"}>
This is a maintenance release with no user-facing changes.
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem pull="6987">
Fixes a crash on startup caused by incorrect permissions on the ID
file.
</ChangeItem>
)}
{title === "Windows" && (
<ChangeItem>
This is a maintenance release with no user-facing changes.
</ChangeItem>
)}
</Entry>
<Entry version="1.3.8" date={new Date("2024-10-08")}>
<ChangeItem pull="6874">Fixes the GUI shutting down slowly.</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6931">
Mitigates an issue where `ipconfig` and WSL weren't aware of Firezone
DNS resolvers. Users may need to restart WSL after signing in to
Firezone.
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="6931">
Mitigates an issue where `ipconfig` and WSL weren't aware of
Firezone DNS resolvers. Users may need to restart WSL after signing
in to Firezone.
</ChangeItem>
)}
</Entry>
<Entry version="1.3.7" date={new Date("2024-10-02")}>
<ChangeItem pull="6831">
@@ -89,9 +99,11 @@ export default function GUI({ title }: { title: string }) {
<ChangeItem pull="6782">
Adds always-on error reporting using sentry.io.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6874">
Fixes a delay when closing the GUI.
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="6874">
Fixes a delay when closing the GUI.
</ChangeItem>
)}
<ChangeItem pull="6857">
Tries to send motherboard's hardware ID for device verification.
</ChangeItem>
@@ -107,17 +119,21 @@ export default function GUI({ title }: { title: string }) {
Fixes an issue where some browsers may fail to route DNS Resources
correctly.
</ChangeItem>
<ChangeItem enable={title === "Linux GUI"} pull="6780">
Fixes a bug where the Linux Clients didn't work on ZFS filesystems.
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem pull="6780">
Fixes a bug where the Linux Clients didn't work on ZFS filesystems.
</ChangeItem>
)}
<ChangeItem pull="6795">
Fixes a bug where auto-sign-in with an expired token would cause a
"Couldn't send Disconnect" error message.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6810">
Fixes a bug where roaming from Ethernet to WiFi would cause Firezone
to fail to connect to the portal.
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="6810">
Fixes a bug where roaming from Ethernet to WiFi would cause Firezone
to fail to connect to the portal.
</ChangeItem>
)}
</Entry>
<Entry version="1.3.4" date={new Date("2024-09-19")}>
<ChangeItem pull="6765">
@@ -133,12 +149,16 @@ export default function GUI({ title }: { title: string }) {
</ChangeItem>
</Entry>
<Entry version="1.3.3" date={new Date("2024-09-13")}>
<ChangeItem enable={title === "Linux GUI"}>
This is a maintenance release with no user-facing changes.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6681">
Fixes a bug where sign-in fails if IPv6 is disabled.
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem>
This is a maintenance release with no user-facing changes.
</ChangeItem>
)}
{title === "Windows" && (
<ChangeItem pull="6681">
Fixes a bug where sign-in fails if IPv6 is disabled.
</ChangeItem>
)}
</Entry>
<Entry version="1.3.2" date={new Date("2024-09-06")}>
<ChangeItem pull="6624">
@@ -165,10 +185,12 @@ export default function GUI({ title }: { title: string }) {
download.
</ChangeItem>
<ChangeItem pull="6449">Checks for updates once a day</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6472">
Fixes an issue where Split DNS didn't work for domain-joined Windows
machines
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="6472">
Fixes an issue where Split DNS didn't work for domain-joined Windows
machines
</ChangeItem>
)}
</Entry>
<Entry version="1.2.1" date={new Date("2024-08-27")}>
<ChangeItem pull="6414">
@@ -188,13 +210,17 @@ export default function GUI({ title }: { title: string }) {
<ChangeItem pull="5901">
Implements glob-like matching of domains for DNS resources.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6280">
Fixes a bug where the "Clear Logs" button did not clear the IPC
service logs.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6308">
Fixes a bug where the GUI could not run if the user is Administrator
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="6280">
Fixes a bug where the "Clear Logs" button did not clear the IPC
service logs.
</ChangeItem>
)}
{title === "Windows" && (
<ChangeItem pull="6308">
Fixes a bug where the GUI could not run if the user is Administrator
</ChangeItem>
)}
<ChangeItem pull="6351">
The log filter on the IPC service is now reloaded immediately when you
change the setting in the GUI.
@@ -226,16 +252,18 @@ export default function GUI({ title }: { title: string }) {
<ChangeItem pull="5923">
Adds the ability to mark Resources as favorites.
</ChangeItem>
<ChangeItem enable={title === "Linux GUI"} pull="6163">
Supports using `etc-resolv-conf` DNS control method, or disabling DNS
control
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem pull="6163">
Supports using `etc-resolv-conf` DNS control method, or disabling
DNS control
</ChangeItem>
)}
<ChangeItem pull="6181">
Improves reliability of DNS resolution of non-resources.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6163">
Supports disabling DNS control
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="6163">Supports disabling DNS control</ChangeItem>
)}
<ChangeItem pull="6184">
Mitigates a bug where the IPC service can panic if an internal channel
fills up
@@ -247,12 +275,14 @@ export default function GUI({ title }: { title: string }) {
</ChangeItem>
</Entry>
<Entry version="1.1.8" date={new Date("2024-08-01")}>
<ChangeItem enable={title === "Linux GUI"} pull="5978">
Adds network roaming support.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="6051">
Fixes "Element not found" error when setting routes.
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem pull="5978">Adds network roaming support.</ChangeItem>
)}
{title === "Windows" && (
<ChangeItem pull="6051">
Fixes "Element not found" error when setting routes.
</ChangeItem>
)}
<ChangeItem pull="6017">
Removes keyboard accelerators, which were not working.
</ChangeItem>
@@ -261,33 +291,43 @@ export default function GUI({ title }: { title: string }) {
</ChangeItem>
</Entry>
<Entry version="1.1.7" date={new Date("2024-07-17")}>
<ChangeItem enable={title === "Linux GUI"} pull="5848">
Stops the GUI and prompts you to re-launch it if you update Firezone
while the GUI is running.
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="5375">
Improves sign-in speed and fixes a DNS leak
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem pull="5848">
Stops the GUI and prompts you to re-launch it if you update Firezone
while the GUI is running.
</ChangeItem>
)}
{title === "Windows" && (
<ChangeItem pull="5375">
Improves sign-in speed and fixes a DNS leak
</ChangeItem>
)}
</Entry>
<Entry version="1.1.6" date={new Date("2024-07-12")}>
<ChangeItem pull="5795">
Unexpected IPC service stops are now reported as "IPC connection
closed".
</ChangeItem>
<ChangeItem enable={title === "Windows"} pull="5827">
Fixes a bug where DNS could stop working when you sign out.
</ChangeItem>
{title === "Windows" && (
<ChangeItem pull="5827">
Fixes a bug where DNS could stop working when you sign out.
</ChangeItem>
)}
<ChangeItem pull="5817">
Shows different tray icons when signed out, signing in, and signed in.
</ChangeItem>
</Entry>
<Entry version="1.1.5" date={new Date("2024-07-08")}>
<ChangeItem enable={title === "Linux GUI"} pull="5793">
The Linux GUI Client is now built for both x86-64 and ARM64.
</ChangeItem>
<ChangeItem enable={title === "Windows"}>
This is a maintenance release with no user-facing changes.
</ChangeItem>
{title === "Linux GUI" && (
<ChangeItem pull="5793">
The Linux GUI Client is now built for both x86-64 and ARM64.
</ChangeItem>
)}
{title === "Windows" && (
<ChangeItem>
This is a maintenance release with no user-facing changes.
</ChangeItem>
)}
</Entry>
<Entry version="1.1.4" date={new Date("2024-07-05")}>
<ChangeItem pull="5700">