https://github.com/samuelmarks/cdd-publisher
https://github.com/samuelmarks/cdd-publisher
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/samuelmarks/cdd-publisher
- Owner: SamuelMarks
- License: apache-2.0
- Created: 2026-06-15T02:41:17.000Z (23 days ago)
- Default Branch: master
- Last Pushed: 2026-06-27T00:42:50.000Z (11 days ago)
- Last Synced: 2026-06-27T02:11:27.536Z (11 days ago)
- Language: Rust
- Size: 114 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# cdd-publisher
> Background worker and publisher service for the `cdd` ecosystem.
[](https://github.com/SamuelMarks/cdd-publisher/actions/workflows/ci.yml)
[](https://opensource.org/licenses/Apache-2.0)
`cdd-publisher` is an asynchronous worker node responsible for pushing generated software development kits (SDKs) to external package registries (npm, PyPI, Cargo, etc.).
## Ecosystem Integration
While users interact primarily with the [CDD Web UI](../cdd-web-ui)—the central graphical interface for configuring, generating, and reviewing SDKs—`cdd-publisher` operates entirely in the background. When a user triggers a release from the Web UI, the request flows through the control plane to the publisher queue. This architecture ensures that slow, network-dependent registry uploads do not bottleneck the frontend experience or the core generation engine.
## Features
- **Asynchronous Execution:** Listens to event queues for publish requests.
- **Registry Integration:** Orchestrates package manager commands safely and consistently.
- **Secure Handling:** Receives decrypted secrets in-memory just-in-time to perform registry authentication.
- **Audit Logging:** Reports the success or failure of release events back to the control plane.
## Prerequisites
- **Rust** (Edition 2024 via the `cargo` toolchain)
- **Redis** server for the event queue broker
- **Python 3** (for local development doc checks)
- **Pre-commit** (for Git hooks)
## Getting Started
### 1. Start the Event Broker (Redis)
You can start a local development Redis server on port 63799:
```bash
redis-server --port 63799
```
### 2. Run the Publisher
Execute the worker node using Cargo:
```bash
cargo run
```
## Development and Contributing
Our codebase enforces 100% documentation coverage and strict linting.
- **Testing:** Run the comprehensive test suite with `cargo test`.
- **Linting:** We enforce strict Clippy rules. Run `cargo clippy --all-targets --all-features`.
- **Pre-commit:** Install pre-commit hooks to ensure code quality before pushing:
```bash
pre-commit install
```
- **Documentation Coverage:** Ensure all public and internal items are documented. You can check for missing docs using the provided utility:
```bash
python check_docs.py
```
## Deployment
The project includes Dockerfiles for containerized deployment:
- `alpine.Dockerfile`: For a minimal, musl-based deployment.
- `debian.Dockerfile`: For glibc-based deployment.
## Architecture
For more deep-dive technical details on constraints, security, and internal workflows, refer to the [ARCHITECTURE.md](ARCHITECTURE.md).
---
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.