Prepare public docs, licensing, and v0.1.0 release - #99
Merged
Conversation
There was a problem hiding this comment.
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) withSHA256SUMS. - 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 on lines
+5
to
+8
| | Version | Supported | | ||
| | --- | --- | | ||
| | 0.1.x | Yes | | ||
| | Unreleased snapshots | No guarantee | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prepare redis-adapter for its first public library release,
v0.1.0, while keeping the RedisAdapter wire protocol at version 1.0.Highlights
LICENSE, a separate Fermilab government-rightsNOTICE, and an inventoriedTHIRD_PARTY_NOTICES.mdVERSION.txt, a dated changelog, and a tag-gated release workflow that publishes a complete source bundle with all pinned submodules plusSHA256SUMSHEXPIREwatchdog coverageRedisConnectioncontract explicit and stop the optional benchmark target from building Google Benchmark's upstream testsVersioning
0.1.01.0(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
--recurse-submodulesredis-adapter-0.1.0-source.tar.gzand includes all seven project/dependency notice filesGitHub CI supplies the authoritative full-suite result against pinned Redis 7.4, including the watchdog test.