Create a changelog file #110

New Issue

oysteikt · 2025-11-26T11:14:38+01:00

oysteikt commented

2025-11-26 11:14:38 +01:00

We should make a running changelog file in the project. The first release can contain a split list of features ported from before the rewrite and after.

(Potentially non-complete) list of features to highlight that have been ported:

all previous commands
SUID/SGID support
CLI interface compatibility (for the most part, see deviation note about the privilege editor)
stdout/stderr compatibility (for the most part, see deviation note about validation ordering, as well as --help)
privilege editor

(Potentially non-complete) list of features to highlight after the rewrite:

server/client design and the security that follows
check authorization command
lock/unlock commands
systemd integration
- watchdog
- status message
- hardening
- socket activation
graceful reload and shutdowns
more in-depth debug logging on the server-side
dynamic completion
bump name length limit from 32 chars to 64 chars
CLI arg based privilege editing
hidden password prompt
change password by file and stdin
adhere to $VISUAL before $EDITOR
display diff before "commiting" privilege edits
json output
more detailed error reporting
- suggest format of db/user name when invalid name entered
- instead of silently trimming db/user name, report as error
- report exactly what went wrong during name validation, instead of general error
- added extra errors related to serialization and server connection
distribution:
- deb files
- systemd units
- nix package + nixos module

Also move the "Known deviations from the original programs" from README to the changelog file

We should make a running changelog file in the project. The first release can contain a split list of features ported from before the rewrite and after. (Potentially non-complete) list of features to highlight that have been ported: - all previous commands - SUID/SGID support - CLI interface compatibility (for the most part, see deviation note about the privilege editor) - stdout/stderr compatibility (for the most part, see deviation note about validation ordering, as well as `--help`) - privilege editor (Potentially non-complete) list of features to highlight after the rewrite: - server/client design and the security that follows - check authorization command - lock/unlock commands - systemd integration - watchdog - status message - hardening - socket activation - graceful reload and shutdowns - more in-depth debug logging on the server-side - dynamic completion - bump name length limit from 32 chars to 64 chars - CLI arg based privilege editing - hidden password prompt - change password by file and stdin - adhere to `$VISUAL` before `$EDITOR` - display diff before "commiting" privilege edits - json output - more detailed error reporting - suggest format of db/user name when invalid name entered - instead of silently trimming db/user name, report as error - report exactly what went wrong during name validation, instead of general error - added extra errors related to serialization and server connection - distribution: - deb files - systemd units - nix package + nixos module Also move the "Known deviations from the original programs" from README to the changelog file

oysteikt added this to the Initial release milestone 2025-11-26 11:14:38 +01:00

oysteikt added the documentation label 2025-11-26 11:14:38 +01:00

oysteikt closed this issue

2025-12-03 10:39:41 +01:00

Sign in to join this conversation.

No Assignees

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: Projects/muscl#110