WoeUSB

This release incorporates the following changes:

💦 Refactoring

Changes that are mostly not noticeable, but improve the overall design for future conveniences:

• We've revamped the print_help function which is previously just a bunch of echos to use utility functions specifically made to output Markdown markup, which should make new help text modification easier(d15bf98).

You can find all the details of this release at https://github.com/WoeUSB/WoeUSB/compare/v5.2.3...v5.2.4

Cheers! 🥂

This release incorporates the following changes:

🔧 Fixes

Changes that fix something that was previously not working, to working:

• We've fixed a problem where WoeUSB will unnecessarily try to unmount the filesystems even when they are not mounted in the first place(9fbe35c).

💦 Refactoring

Changes that are mostly not noticeable, but improve the overall design for future conveniences:

• We've dropped the print_version function which is essentially a single printf call, we would like to thank @rndd-github for noting it(#38).
• We've enhanced the check_function_parameters_quantity function to handle optional arguments(9fbe35c).

You can find all the details of this release at https://github.com/WoeUSB/WoeUSB/compare/v5.2.2...v5.2.3

Cheers! 🥂

This release incorporates the following changes:

🔧 Fixes

Changes that fix something that was previously not working, to working:

• We've fixed a minor issue where we assume that the only superuser possible on a Linux system is root, which is untrue considering that anyone with UID 0 is considered a superuser.

💦 Refactoring

Changes that are mostly not noticeable, but improve the overall design for future conveniences:

• We've improved the error messages when source/target filesystem mounting fails
• We've dropped unnecessary custom error messages in mount_source_filesystem and mount_target_filesystem
• We've improved the check_superuser function's name to be more clear what it is actually doing

You can find all the details of this release at https://github.com/WoeUSB/WoeUSB/compare/v5.2.1...v5.2.2

Cheers! 🥂

This release incorporates the following changes:

🔧 Fixes

Changes that fix something that was previously not working, to working:

• We've fixed a regression shipped in WoeUSB 5.2.0 that involves an incorrect Arithmetic Expansion syntax, we would like to thank @minneelyyyy and @jrabinow for providing patches.
  UPDATE: The regression is in the unreleased development snapshot(c3c7d563662725af97f53ba99417daa5798cc882).
• We've fixed a regression shipped in WoeUSB 5.2.0 that involves a fatal error caused by the invalid function call, we would like to thank Steve Bennett(@stevage) for reporting the issue.

🤏 Linting

Changes that fix potential problems that may have the potential that become a real one:

• We've fixed several types in the documentation and the comments, we would like to thank @minneelyyyy for providing the patch.

You can find all the details of this release at https://github.com/WoeUSB/WoeUSB/compare/v5.2.0...v5.2.1

Cheers! 🥂

This release incorporates the following changes:

🔧 Fixes

Changes that fix something that was previously not working, to working:

• We've changed the way to download UEFI: NTFS support filesystem image, it is previously downloaded directly from GitHub but users in China have problems accessing it due to the intentional DNS pollution implemented by their government. We now download it via the jsDelivr CDN to work around this issue.

  We have evaluated jsDelivr CDN beforehand and determined that it is trustworthy to rely on, however, if you have any reasonable concerns to revert or customize this change please feel free to file an issue on our issue tracker.

  We would like to thank:

  • @Rsplwe for describing the problem and generously providing a patch
  • @pbatard for joining the discussion and providing their input on the implementation

🖊️ Documentation

Changes that contribute to the product's documentation:

• We've improved the credits section in the project README to properly attribute everyone we are grateful to 🙇 .
• We've added a version compare link at the bottom of the release notes(the one you're now reading) to increase the transparency of our changes.

You can find all the details of this release at Comparing v5.1.3...v5.2.0 · WoeUSB/WoeUSB

Cheers! 🥂

This release incorporates the following changes:

🔧 Fixes

Changes that fix something that was previously not working, to working:

• We've fixed a problem where WoeUSB will error during the preparation process due to the recent UEFI:NTFS image size changes(#81, #82). We would like to apologize for the frustration in the time being as we are unable to deliver the fix as soon as possible(the maintainer was unfortunately run out of capacity and were unable to respond to the incident).

  We would like to thank:

  • @arjenv for reporting the issue
  • Pete Batard for their kind answer and issue redirection on the corresponding Ask Ubuntu question
  • Zachary Talis for their workaround to the bug

• We've fixed incompatibility when the script is provided to the interpreter via the standard input device(stdin) (7fec845)

💦 Refactoring

Changes that are mostly not noticeable, but improve the overall design for future conveniences:

• We've unified the usage of the local command when declaring variables in functions, which should slightly improve code readability(c97d1e5)
• We've adjusted the order of some of the code to improve code readability(481c250)
• We've simplified the unnecessarily lengthy temp_dir variable name(2571a16) and is_var_set_and_not_empty utility function(3d7095a)
• We've improved the script primitive variable definitions by using GNU Bash's builtin parameter expansion features instead of external command calls(e136f14)

🤏 Linting

Changes that fix potential problems that may have the potential that become a real one:

• We've fixed some typos within our code(481c250)
• We've fixed several missing line breaks in the messages(76efeda)

Cheers! 🥂

This release incorporates the following changes:

🔧 Fixes

Changes that fix something that was previously not working, to working:

• We've fixed Slackware Linux compatibility by changing the template used to create the temporary directory. We would like Sérgio Surkamp to properly reporting the issue.

Cheers! 🥂

This release incorporates the following changes:

💦 Refactoring

Changes that are mostly not noticeable, but improves the overall design for future conveniences:

• We've dropped the unnecessary and bloated license declaration text as the SPDX license identifier should be enough to announce the license of the script. This also improves readability by giving easier access to the actual code.
• We've eliminated the unnecessary target fs label variable.
• We've dropped an unnecessary state-tracking variable that serves no purpose aside from the initial expectation.
• We've dropped the echo_with_color function as the use of the echo command is unreliable and to ease our burden of maintaining two message printing functions.
• We've implemented specific functions for message output to replace the generic printf* functions, which should make the message more unified and also ease the developers from enumerating all the unnecessary details just for printing a message (and often done wrongly).

🤏 Linting

Changes that fix potential problems that may have the potential that become a real one:

• We've fixed some typos and some grammar problems in our release note draft.
• We've added the legal compliance section to the release note draft to ease future publications
• We've replaced an icon representing new features in the release draft
• We've fixed a typo in the core script's file header
• We've dropped an unnecessary quoting of a string without special characters to Bash

Cheers! 🥂

This release incorporates the following changes:

🌟 New features

Changes that introduce new features or functionalities:

• We've implemented the support to prepare FAT32 devices using a Windows source image with WIM archives that are over the FAT32 file size limit(4GiB). It works by using the file splitting feature of wimlib to split oversized WIM archives to be under the file size limit, thus are able to put into the FAT32 filesystem. This shrinks the preparation time of a Windows 10 20H2 v2 source image from ~30min. to 2:13!

  We would like to thank @varred at GitLab for the WinToUsbLinux implementation which is served as a reference for this feature.

  As a side effect, WoeUSB now requires an installation of wimlib as a runtime dependency.

⚖️ Legal compliance

Changes that ensure that WoeUSB can be legally distributed and (re)used as much as possible.

• We've improved the REUSE-compliance by using the proper LicenseRef for our partially fair used assets(namely the new logo)

Cheers! 🥂

This release incorporates the following changes:

🔧 Fixes

Changes that fix something that was previously not working, to working:

• We've fixed the issue where the error trap is always triggered regardless of the result of the program.

Cheers! 🥂

This release incorporates the following changes:

🖊️ Documentation

Changes that contribute to the product's documentation:

• We've improved the clarity of the product's license so that one can reuse this product more easily.

Cheers! 🥂

This release incorporates the following changes:

🖌️ Branding

Changes that contribute to the product's promotion:

• We've introduced the new GNOME HIG compliant WoeUSB icon/logo design, we would like to thank the generous contribution from Lorenzo Ragni!

  

Cheers! 🥂

💦 Refactoring

Mostly not noticeable, but it improves the overall design for future conveniences:

• We've become REUSE-compliant to ease copyright concerns

Cheers! 🥂

🔧 Bug fixes

Fix something that was previously not working, to working:

• We've fixed a missing command dependency in the check_runtime_dependencies function

🤏 Linting

Fixing potential problems that may have the potential that become a real one:

• We've added the missing ShellCheck and Markdownlint pre-commit hook for verification in continuous integrations
• We've fixed the MD007 and MD026 Markdownlint problem in the bug report template

🖊️ Documentation

• We've fixed the project URL and version string on the manual page
• We've added the SPDX License Identifier in our program for better declaration of the code's license

Cheers! 🥂

🤏 Linting

Fixing potential problems that may have the potential that become a real one.

• Fix missing mandatory quoting for command substitution

Cheers! 🥂

💥 Breaking changes

Changes that cause the bumping of the major version:

• We've dropped the GUI wrapper support code due to its unmaintained status, though --for-gui command-line option is preserved for compatibility we can no longer ensure that it will be compatible with the current wrapper code

🔧 Fixes

Fix something that was previously not working, to working.

• We've "fixed" the incompatible Linux write buffer workaround by dropping the workaround altogether due to the following reasons:

  • Detecting supported kernel versions is hard, or at least not simple
  • This is not really WoeUSB's problem, but the Linux kernel's issue
  • This workaround isn't possible with distributions that use confinement (e.g. Snaps)

  We have added a F.A.Q. entry for affecting users to deal with this problem manually.

💦 Refactoring

Mostly not noticeable, but it improves the overall design for future conveniences.

• We've renamed the RUNTIME_* variables to script_* and program_* for better readability
• We've moved the entry point init function as close as possible to the script header for better readability
• We've dropped the read-only function declarations as it serves little benefit in practice and reduces readability
• We've consolidated the compatibility notes to the script header for readability
• We've dropped the util_* prefix for utility functions for better readability
• We've dropped the function alias design as it doesn't work well for its intended purposes and causes more pain to the developing

Cheers! 🥂