Skip to content

Ship the certs, test sources and examples in make dist - #67

Open
Frauschi wants to merge 1 commit into
wolfSSL:mainfrom
Frauschi:dist-files
Open

Frauschi wants to merge 1 commit into
wolfSSL:mainfrom
Frauschi:dist-files

Conversation

@Frauschi

@Frauschi Frauschi commented Nov 13, 2026 •

Copy link
Copy Markdown
Member

make dist left out examples/certs/, the examples, tests/CMakeLists.txt and tests/test_static_mem.h, so a release tarball could not build the tests with either build system or the examples with CMake, nor run the Zephyr sample or the README CLI demo. Autoconf never built the examples at all: --enable-examples was a no-op.

Changes

  • List each tracked file under examples/ and tests/test_static_mem.h, tests/CMakeLists.txt in EXTRA_DIST
  • Build the three examples with autoconf under --enable-examples, gated on EST/SCEP as in CMake
  • make distcheck configures with --enable-tests --enable-examples
  • .gitignore covers the in-tree autoconf example binaries
  • AGENTS.md: the test credentials must never be deployed, rather than never shipped

Testing

  • The autoconf-full PR job now runs make distcheck, which builds the tests and examples from the tarball and runs the tests
  • cmake-full-werror builds the examples with -Werror

Fixes F-16526.

@Frauschi Frauschi self-assigned this Nov 13, 2026
Copilot AI balanced review requested due to automatic review settings November 13, 2026 13:48

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues were identified for the release-tarball packaging and validation changes.

No open issues 🎉

What changed in this PR

This PR makes release tarballs include the files needed to build tests and examples and run certificate-based demos, addressing F-16526.

Changes:

  • Adds example sources, test credentials, and missing test support files to EXTRA_DIST.
  • Enables tests during make distcheck and runs it in the autoconf CI job.
  • Documents tarball validation and clarifies that test credentials must never be deployed.
File Description
Makefile.am Includes missing distribution files and enables tests for distcheck.
docs/​CI.md Documents release-tarball validation in CI.
AGENTS.md Changes the test-credential warning from shipping to deployment.
.github/​workflows/​pr.yml Runs autoconf distcheck and prints logs on failure.

Review effort: Balanced

@Frauschi

Copy link
Copy Markdown
Member Author

@claude review

@wolfSSL-Fenrir-bot wolfSSL-Fenrir-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fenrir Automated Review — PR #67

Scan targets checked: wolfcert-pr-general
Review type: general (no scan target covers the changed files)
Coverage: 2 of 4 in-scope changed file(s) opened by the reviewer; not opened: AGENTS.md, docs/CI.md

Fenrir result: Approved ✅

No new issues found in the changed files.

Advisory only — this automated result does not count as a GitHub approval.

Review tier: Max

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.

Comment thread Makefile.am Resolved

@yosuke-wolfssl yosuke-wolfssl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.
Please rebase onto main to make Zephyr job green.

EXTRA_DIST left out examples/certs, tests/test_static_mem.h,
tests/CMakeLists.txt and the examples. From a release tarball,
./configure --enable-tests failed to compile (most unit tests include
../test_static_mem.h), CMake with tests or examples on stopped at the
missing subdirectory, and the Zephyr EST sample and test, the host
server for the Zephyr test and the README CLI demo lacked the
credentials they load from examples/certs.

List each tracked file rather than the directories, so a stray local
file never ships, and have make distcheck configure with --enable-tests
so a test file missing from EXTRA_DIST fails it. The autoconf PR job now
runs make distcheck, which keeps that check from going stale. The certs
are throwaway test credentials, so the AGENTS.md row now says never
deploy them rather than never ship them.

The autoconf build now builds the examples too: --enable-examples was
accepted but built nothing. They are noinst programs gated on EST and
SCEP as in examples/CMakeLists.txt, automake ships their sources, and
make distcheck also configures with --enable-examples, so the PR job
compiles them from the tarball. No CI job built them before; the
cmake-full-werror job now does too, so a warning in an example fails
it. .gitignore covers the binaries of an in-tree autoconf build.

Fixes F-16526.
@Frauschi

Copy link
Copy Markdown
Member Author

@yosuke-wolfssl done, CI is fully green now. Thanks!

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.

5 participants