Skip to content

Prepare public docs, licensing, and v0.1.0 release - #99

Merged
derekste merged 2 commits into
mainfrom
dev/public-docs-license-release
Jul 15, 2026
Merged

Prepare public docs, licensing, and v0.1.0 release#99
derekste merged 2 commits into
mainfrom
dev/public-docs-license-release

Conversation

@derekste

Copy link
Copy Markdown
Member

Summary

Prepare redis-adapter for its first public library release, v0.1.0, while keeping the RedisAdapter wire protocol at version 1.0.

Highlights

  • replace the mixed license text with an exact BSD 3-Clause LICENSE, a separate Fermilab government-rights NOTICE, and an inventoried THIRD_PARTY_NOTICES.md
  • add VERSION.txt, a dated changelog, and a tag-gated release workflow that publishes a complete source bundle with all pinned submodules plus SHA256SUMS
  • reorganize the README around the library's useful behavior: typed Redis Streams, nanosecond stream IDs, reconnecting readers, deferred reader topology changes, cluster hash-slot keys, connection options, and watchdogs
  • add a documentation index, source-build/CMake guide, API guide, release guide, contribution guide, security policy, issue forms, and PR template
  • move public CI to push and pull-request validation on GitHub-hosted Ubuntu without institutional secrets
  • replace the checked-in 7 MB Redis executable with a pinned official Redis 7.4 test container, keeping HEXPIRE watchdog coverage
  • add Dependabot coverage for Actions, Docker, and git submodules
  • make the already non-movable RedisConnection contract explicit and stop the optional benchmark target from building Google Benchmark's upstream tests

Versioning

  • C++ library: 0.1.0
  • RedisAdapter wire protocol: 1.0 (unchanged)
  • Runtime/wire format: unchanged

The pre-1.0 library version is intentional: the protocol is documented and stable at v1.0, but the C++ API still has open hardening work before making a stable-library compatibility promise.

Validation

  • anonymous credential-disabled HTTPS clone with --recurse-submodules
  • all project workflow and issue-form YAML parses
  • all workflow shell blocks and repository shell scripts pass syntax validation
  • Docker Compose test definition renders successfully
  • all project-local Markdown links resolve
  • clean C++17 configure/build on macOS
  • README example passes C++17 syntax compilation
  • 12 non-watchdog tests pass against local Redis 7.0 over TCP and Unix socket
  • C++20 test and benchmark targets build; Google Benchmark's own test suite is no longer built
  • release packaging command creates redis-adapter-0.1.0-source.tar.gz and includes all seven project/dependency notice files

GitHub CI supplies the authoritative full-suite result against pinned Redis 7.4, including the watchdog test.

Copilot AI review requested due to automatic review settings July 15, 2026 14:59

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.

Pull request overview

Prepares redis-adapter for an initial public v0.1.0 source release by formalizing licensing/notices, expanding user + maintainer documentation, and updating CI/release automation while keeping the RedisAdapter wire protocol at v1.0.

Changes:

  • Introduces release metadata (VERSION.txt, CHANGELOG.md) and a tag-driven release workflow that publishes a complete source bundle (including pinned submodules) with SHA256SUMS.
  • Reworks public documentation: revamped README plus new docs for building, API usage, and releasing; adds contributing and security policy guidance.
  • Updates CI to run on GitHub-hosted Ubuntu using a pinned Redis 7.4 container (and adds Dependabot coverage).

Reviewed changes

Copilot reviewed 24 out of 25 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
VERSION.txt Adds semantic library version source of truth (0.1.0).
THIRD_PARTY_NOTICES.md Inventories submodule dependency licenses and clarifies what’s redistributed.
SECURITY.md Adds a security policy and private vulnerability reporting instructions.
RedisConnection.hpp Makes RedisConnection explicitly non-movable (move ctor deleted).
redis-start.sh Hardens the local Redis helper script (strict bash, quoting, clearer output).
README.md Rewrites README around public-library usage, features, quick start, and doc links.
NOTICE Adds government-rights notice separate from the license text.
LICENSE Normalizes license to BSD 3-Clause (and updates copyright year).
docs/releasing.md Documents the release/tagging process and artifact expectations.
docs/README.md Adds a documentation index and versioning model overview.
docs/building.md Adds source build, dependency, test Redis, and integration guidance.
docs/api.md Adds an API guide describing connection/options, reads/writes, readers, and errors.
docker-compose.test.yml Defines pinned Redis 7.4 test environment with Unix socket support.
CONTRIBUTING.md Adds contribution workflow expectations for a public repo.
CMakeLists.txt Reads VERSION.txt for project(... VERSION ...) and disables Benchmark tests.
CHANGELOG.md Adds dated changelog entry for 0.1.0.
.github/workflows/test.yml Moves CI to push+PR on main, uses pinned Redis via Compose, adds validation.
.github/workflows/test-and-benchmark.yml Updates manual workflow to use pinned Redis + CMake C++20 for benchmarks.
.github/workflows/release.yml Adds tag/dispatch release publisher with source-bundle + checksum artifacts.
.github/pull_request_template.md Adds a structured PR template for compatibility/validation.
.github/ISSUE_TEMPLATE/feature.yml Adds feature request issue form with compatibility prompts.
.github/ISSUE_TEMPLATE/config.yml Disables blank issues and adds security contact link.
.github/ISSUE_TEMPLATE/bug.yml Adds bug report form with required reproduction + environment fields.
.github/dependabot.yml Enables Dependabot for Actions, Docker, and git submodules.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CMakeLists.txt Outdated
Copilot AI review requested due to automatic review settings July 15, 2026 15:05

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.

Pull request overview

Copilot reviewed 24 out of 25 changed files in this pull request and generated 1 comment.

Comment thread SECURITY.md
Comment on lines +5 to +8
| Version | Supported |
| --- | --- |
| 0.1.x | Yes |
| Unreleased snapshots | No guarantee |
@derekste
derekste merged commit b8cb90c into main Jul 15, 2026
2 checks passed
@derekste
derekste deleted the dev/public-docs-license-release branch July 15, 2026 15:10
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.

2 participants