CodeWiki Plugin

Use the plugin to call AI Large Language Models (LLM) to generate Wiki documentation for repositories.

cnbcool/codewiki

• git_doc_dir: Required. Specifies the save location for codewiki generated documentation
• knowledge_enabled: Whether to enable knowledge base ingestion, default false. Set to true to automatically ingest generated Wiki documents into the repository knowledge base
• knowledge_embedding_model: Embedding model name, default hunyuan
• knowledge_chunk_size: Text chunk size (in tokens), default 1500
• knowledge_chunk_overlap: Overlap token count between adjacent chunks, default 0

$:
  tag_push:
    - stages:
        - name: Generate Code Wiki
          timeout: 4h
          image: cnbcool/codewiki:latest
          settings:
            git_doc_dir: /${CNB_BUILD_WORKSPACE}/${CNB_REPO_SLUG}/codewiki

CNB_BUILD_WORKSPACE and CNB_REPO_SLUG are built-in default environment variables in CNB pipeline. For more environment variables, click here to get more details

$:
  tag_push:
    - services:
        - docker
      docker:
        volumes:
          - /data/codewiki/${CNB_REPO_SLUG}:data
      stages:
        - name: Generate Code Wiki
          timeout: 4h
          image: cnbcool/codewiki:latest
          settings:
            git_doc_dir: /data/codewiki/${CNB_REPO_SLUG}

It is recommended to use the tag_push event to avoid frequent generation of wiki documentation.