Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions changes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
Common Changelog Snippets
=========================

These changelog snippets are to assist to automagically create TurnKey Linux
appliance changelog entries which include all relevant changes- including
common changes.

This ensures that each appliance changelog is complete and standalone, but
without need to manually copy/paste shared changelog entries.

Filename & Format Specification
-------------------------------

Changelog snippet files should be named::

COMMON/changes/COMMON_MAKFILE.changelog

Where:
FAB_PATH path to 'fab' directory; defaults to '/turnkey/fab/'
COMMON '$FAB_PATH/common/'
COMMON_MAKFILE Name of common makefile in 'COMMON/mk/turnkey/'; e.g.
'apache' refers to 'COMMON/mk/turnkey/apache.mk'
COMMON_CHANGELOG Matching changelog file; e.g.:
'COMMON/changes/apache.changelog'
TKL_VERSION Numerical TurnKey Linux version; e.g. '19.0'

The contents must be formatted as per valid Debian changelog requirements. The
firstline of each new release entry should be in the following format::

```
turnkey-COMMON_MAKFILE_NAME-TKL_VERSION (1) turnkey; urgency=low
```

E.g. to reuse the foo example from above:

```
turnkey-apache-19.0 (1) turnkey; urgency=low
```

And must end with a signoff line, e.g.:

```
-- Jeremy Davis <jeremy@turnkeylinux.org> Tue, 01 Aug 2026 02:12:50 +0000
```


Generating Individual Appliance Changelogs
------------------------------------------

To generate the new appliance changelog format, ensure that the
'tkldev-detective' package is installed. I.e.:

```
apt update
apt install -y tkldev-detective
```

Once installed, in the base appliance build code directory (e.g.
'$FAB_PATH/products/lamp'), to create a new minor version changelog (e.g.
'18.1') run this:

```
tkldev-changelog -n
```

To create a new major version - e.g. 19.0, run this:

```
tkldev-changelog -N
```

To update an existing changelog entry:

```
tkldev-changelog -e
```

For more info, read the `tkldev-changelog --help`.

Please note that currently, tkldev-changelog only supports 'vim' text editor.
If you are unfamiliar with vim (and can't be bothered learning it - which you
probably should...), then you can use the automation of tkldev-changelog to
generate the changelog with common entries, then save and exit vim using the
following key presses::

:wq<ENTER>

Then re-open the file with your preferred editor to add appliance specific
entries. Be careful to ensure that the format is correct - you can double check
(and update the date) with:

```
tkldev-changelog --date
```

No error messages means everything is good! :)


Future Development
------------------

It is anticipated that in future we will likely explicitly generate the
exhaustive individual appliance changelogs at build time (and individual app
devs/maintainers can just do an app specific changelog). In the meantime,
changelogs will need to be generated semi-manually.
77 changes: 0 additions & 77 deletions changes/README.rst

This file was deleted.

3 changes: 0 additions & 3 deletions changes/lamp.changelog

This file was deleted.

3 changes: 0 additions & 3 deletions changes/lapp.changelog

This file was deleted.

3 changes: 0 additions & 3 deletions changes/php-fpm.changelog

This file was deleted.

28 changes: 19 additions & 9 deletions changes/turnkey.changelog
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ turnkey-core-19.0 (1) turnkey; urgency=low
risk of user accidentally locking themself out.
- Removed redundant v18.x custom patches.

* Leverage 'iptables-persistent' package to manage firewall start/stop.

* Include 'zstd' by default to support smaller initramfs that unpacks faster.

* Replace 'ifupdown' with 'ifupdown-ng' (and 'ifupdown-ng-compat').

* Replace 'udhcpc' (IPv4 only) with 'dhcpcd-base' (dual stack ipv4/6). Also
include custom TurnKey config ('tkl-dhcpcd-ifupdown-glue') to ensure DHCP
config is in sync with interfaces file.
include custom TurnKey config (if-pre-up & if-post-down scripts provided by
'tkl-dhcpcd-ifupdown-glue') to ensure DHCP config is in sync with
/etc/network/interfaces file.

* General code cleanup including linting, formating and style updates. Still
WIP but solid start.
* General code cleanup of TurnKey code; build code, build tools and TurnKey
custom tools & libraries. Updates include linting, formating and style
updates. Still WIP but solid start.

* Configuration console (confconsole):

Expand All @@ -42,7 +42,10 @@ turnkey-core-19.0 (1) turnkey; urgency=low

- Features:
- "Proper" support for IPv6:
- Show IPv6 info on "usage" page. Special thanks to Marcos:
- Make ifutil.py module code "IPv6 aware", including reliable
management of /etc/network/interfaces with "inet6" stanza/s.
- Show IPv6 info on "usage" page - only shown if IPv6 configured.
Special thanks to Marcos:
https://github.com/marcos-mendez - https://popsolutions.co/

- Misc clean up and improvements in code and packaging. See Confconsole
Expand Down Expand Up @@ -95,7 +98,14 @@ turnkey-core-19.0 (1) turnkey; urgency=low
with the intention of following upstream releases as closely as possible
(provided via TurnKey apt repo).

- Ensure that Webmin listens via IPv6 by default.
- Updated default Webmin config:
- Listen on IPv6 by default.
- Preconfigured IPv6 firewall matching IPv4 rules (but not enabled - as
per historical IPv4 default).
- Auto redirect http => https.
- Default 30 min user logout (can be overridden via login page "remember
me" checkbox or webmin "authentication" config).
- Updated logging paths and fixed log file rotation.

* Backup (tklbam):

Expand All @@ -116,7 +126,7 @@ turnkey-core-19.0 (1) turnkey; urgency=low

* Misc code cleanup and improvements.

-- Jeremy Davis <jeremy@turnkeylinux.org> Thu, 18 Jun 2026 14:53:42 +1000
-- Jeremy Davis <jeremy@turnkeylinux.org> Thu, 16 Jul 2026 09:05:04 +1000

turnkey-core-18.1 (1) turnkey; urgency=low

Expand Down