Skip to content

Release prep for v1.1.0: README audit, ship the knock client (issue #53) - #54

Merged
Crank-Git merged 6 commits into
devfrom
docs/release-prep
Nov 3, 2026
Merged

Crank-Git merged 6 commits into
devfrom
docs/release-prep

Conversation

@Crank-Git

Copy link
Copy Markdown
Owner

Problem

Ahead of promoting dev to main and tagging v1.1.0:

Fix

  • README, top to bottom: how-it-works + diagram (UDP via
    sourceknock-knock, bounded state, sessions survive the close), Layout,
    Build & test (test-asan, fuzz, e2e/systemd commands), CI, Releases,
    config example (knock_port commented, with the matching -p usage),
    knocking options/examples and release downloads, install paths (client, man
    pages), default config path, fail-closed stop and how to delete the table,
    the 4096-client bound, and Troubleshooting for each startup refusal message.
  • release.yml builds make daemon client, smoke-runs the client, and
    attaches both sourceknock and sourceknock-knock.
  • Default config path is /etc/sourceknock/sourceknock.conf.
  • Man pages: version 1.1; the client in FILES; EXIT STATUS covers the
    link-type and nftables startup checks and the cleanup.
  • Merged main into this branch (Dependabot chore: bump actions/checkout from 4 to 7 #29/chore: bump softprops/action-gh-release from 2 to 3 #30) so the promotion is a
    clean fast-forward of history; the new systemd job uses checkout@v7 like the
    others.

Verification

  • make test: ALL GREEN (it parses the README's config example, so the edited
    block is checked). make check-format: clean.
  • Every log string, path and behavior the README now quotes was checked
    against the code.

Closes #53

Crank-Git and others added 6 commits October 24, 2026 18:03
Promote dev → main (all expansions: #1, #3, #4, #5, #6)
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 7.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 2 to 3.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
- [Commits](softprops/action-gh-release@v2...v3)

---
updated-dependencies:
- dependency-name: softprops/action-gh-release
  dependency-version: '3'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
#53)

- README brought up to date with #31-#41: how-it-works diagram (UDP knocks
  via sourceknock-knock), Layout (close.c, link-type detection, no de-dup,
  contrib/man/examples), Build & test (test-asan, fuzz, e2e/systemd scripts),
  CI (sanitizers, fuzz, e2e, systemd job), Releases (daemon + client),
  config example (knock_port commented, matching the knocking example),
  install paths, fail-closed stop and how to remove the table, the client
  table bound, and Troubleshooting for the startup refusals.
- release.yml builds and attaches sourceknock-knock alongside the daemon.
- The daemon's built-in default config path was /etc/sourceknock.conf; the
  man page, README, units and `make install` all use
  /etc/sourceknock/sourceknock.conf. Use that.
- Man pages: version 1.1, client in FILES, EXIT STATUS reflects the new
  startup checks.
- Brings main's Dependabot bumps (#29, #30) into dev; the new systemd CI job
  uses actions/checkout@v7 like the rest.
@Crank-Git
Crank-Git merged commit ac0b05f into dev Nov 3, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant