Skip to content

🚀 Release v1.0.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 08 Sep 12:21
· 5 commits to main since this release
v1.0.0
48255db

✅ Doc Gen v1.0.0 — Stable Repository Documentation Toolkit

Doc Gen v1.0.0 promotes the redesigned documentation foundation reviewed in
v1.0.0-rc.1 to the stable 1.0 release line. The Doc Gen name was introduced
in RC.1 after the project was known as print_project_structure in v0.1.0.

Doc Gen now provides focused workflows for generating structured Markdown
documentation, printing repository trees, and analyzing project structure. It
replaces the v0.1.0 standalone script with an installable, configurable, tested,
and automation-friendly CLI.

  • Concise, actionable command errors with reliable nonzero exits and debug-only implementation tracebacks.

  • Generate structured Markdown with doc-gen structure generate [target].

  • Print repository trees with the read-only doc-gen structure print [target] command.

  • Analyze repository structure with the read-only doc-gen structure analyze [target] command.

  • Initialize namespaced .config/doc_gen/config.toml settings with doc-gen init.

  • Select minimal, default, or detailed profiles.

  • Use smart mode to adapt settings to repository characteristics.

  • Configure target, output, depth, file visibility, collapse behavior, project type, and ignores.

  • Preview initialization and generation safely with --dry-run.

  • Use Rich terminal guidance, logging, automated tests, MkDocs docs, Make, Docker, Compose, GitHub Actions, and GitLab CI.

  • Preserve Python 3.9 compatibility through tested traversal, model, annotation, and TOML-loading behavior while keeping Python 3.14 as the standard runtime.

  • Use release pipelines that derive registry destinations from the active repository, require reviewed annotated tags, preserve safely rendered complete tag-message notes with populated metadata and literal Docker commands, publish exact prerelease images, and publish stable images under exact, minor, major, and latest tags.

  • structure print and structure analyze are read-only.

  • structure generate writes only its resolved output document.

  • structure generate --dry-run scans and renders without creating the output directory or Markdown file.

  • init --dry-run previews scaffolding without creating or overwriting project configuration.

  • Diagnostic logs may still be written, but dry-run does not modify target-project output.

  • Update project references from print_project_structure to Doc Gen.

  • Install and invoke the doc-gen console command instead of running print_project_structure.py directly.

  • Choose structure generate, structure print, or structure analyze explicitly.

  • Move configuration to .config/doc_gen/config.toml.

  • Place options before the optional target path.

  • Review generation with --dry-run before replacing maintained documentation.

CLI, configuration, scanning, detection, smart mode, profiles, renderers,
writing, initialization, UI, and logging are separated into focused modules.
This makes behavior easier to locate, test, debug, maintain, and extend than the
former single-script implementation.

Authorized users can install the stable package from the private GitLab
registry. Configure pip authentication with a deploy token limited to
read_package_registry, then use the token-free project index URL:

python -m pip install \
  --index-url "https://gitlab.com/api/v4/projects/<project-id>/packages/pypi/simple" \
  "doc-gen==1.0.0"

Supply credentials through an approved protected pip credential mechanism or
its interactive authentication flow. Never commit tokens or include them in
shared command history. Only the protected release pipeline publishes packages;
unprotected tags remain validation-only.

  • Version: v1.0.0
  • Previous version: v1.0.0-rc.1
  • Previous stable version: v0.1.0
  • Release lineage: v0.1.0 → pre-RC checkpoints 1–4 → v1.0.0-rc.1 → post-RC stabilization → v1.0.0
  • Strategy: Semantic Versioning
  • Package compatibility: Python 3.9+
  • Standard development/container runtime: Python 3.14
  • Stability: Stable for the documented command set
  • Container tags: v1.0.0, v1.0, v1, and latest; exact version recommended for reproducible automation

Thank you for validating the release candidate and helping make the redesigned
Doc Gen foundation ready for stable use.

Release: v1.0.0
Author: Devalltect / Rizky Fernandes

📅 Release Information

  • Version: 1.0.0
  • Release Type: stable
  • Repository: devalltect00/Doc-Gen
  • Commit: 48255db448e3e6338c6fcc1a2ab0297be93ba9d5
  • Workflow: 🚀 Release

🐳 Docker Image

Pull the exact release image:

docker pull ghcr.io/devalltect00/doc-gen:v1.0.0

Verify the CLI:

docker run --rm ghcr.io/devalltect00/doc-gen:v1.0.0 --help

Stable releases also update the latest image tag.

📥 Python Package

Wheel and source-distribution artifacts are attached to this release.

Assets 4
Loading