CI Dokumentor

⚠️ Work in Progress!

📢 CI Dokumentor is an automated documentation generator for CI/CD components

📖 Documentation

Complete documentation is available at: hoverkraft-tech.github.io/ci-dokumentor

Quick Links

• 🚀 Getting Started - Installation and quick start
• 📦 Packages - Package documentation
• 🐳 Docker - Docker integration guide
• 🔧 GitHub Action - GitHub Actions integration
• 👨‍💻 Contributing - How to contribute

Usage

Writing

Linting

Supported CI/CD components

GitHub Actions

Actions

Workflows

Integrations

Npm package

npx ci-dokumentor /path/to/ci-cd/component.yml

Docker

CI Dokumentor is available as a Docker image that provides a lightweight, containerized way to generate documentation for your CI/CD components.

Quick Start

# Show available options
docker run --rm ghcr.io/hoverkraft-tech/ci-dokumentor:latest --help

# Generate documentation from CI/CD file
docker run --rm -v $(pwd):/workspace ghcr.io/hoverkraft-tech/ci-dokumentor:latest \
  /workspace/.github/workflows/ci.yml --output /workspace/docs

GitHub Actions Integration

- name: Generate CI Documentation
  uses: docker://ghcr.io/hoverkraft-tech/ci-dokumentor:latest
  with:
    args: '.github/workflows/ci.yml --output docs'

GitLab CI Integration

generate-docs:
  stage: docs
  image: ghcr.io/hoverkraft-tech/ci-dokumentor:latest
  script:
    - ci-dokumentor .gitlab-ci.yml --output docs
  artifacts:
    paths:
      - docs/

Dagger.io Integration

func (m *MyModule) GenerateDocs(ctx context.Context, source *dagger.Directory) *dagger.Directory {
    return dag.Container().
        From("ghcr.io/hoverkraft-tech/ci-dokumentor:latest").
        WithMountedDirectory("/workspace", source).
        WithWorkdir("/workspace").
        WithExec([]string{"ci-dokumentor", ".github/workflows/ci.yml", "--output", "docs"}).
        Directory("docs")
}

📖 Full Documentation: See docker/README.md for complete Docker usage guide, troubleshooting, and advanced configurations.

GitHub Action

👨‍💻 Contributing

👍 If you wish to contribute to CI Dokumentor, PRs are welcome! Please read our Contributing Guide for detailed instructions on:

• Setting up the development environment
• Running tests and linting
• Submitting pull requests
• Code conventions and architecture

Author

👤 Hoverkraft

• Site: https://hoverkraft.cloud
• GitHub: @hoverkraft-tech

📝 License

Copyright © 2020 Hoverkraft.
This project is MIT licensed.