.gitlab-ci.yml

# docker image from https://github.com/DavidAnson/markdownlint-cli2
# vscode markdownlint https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
# markdownlint-cli2: https://github.com/DavidAnson/markdownlint-cli2
# markdownlint rules: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
# markdown-link-check: https://github.com/tcort/markdown-link-check

variables:
  GIT_DEPTH: "0"
  GITHUB_REPO: git@github.com:kendryte/k230_rtos_docs.git
  MARKDOWN_IMAGE: ai.b-bug.org:5000/markdown:latest
  DOCS_BUILDER_IMAGE: ai.b-bug.org:5000/huangziyi/web-docs-builder:3d9c3f0b2be1fe67b3b2f4e5d47504f6c2662b76
  DEPLOY_IMAGE: ai.b-bug.org:5000/huangziyi/deploy:v1

stages:
  - test
  - build
  - deploy

workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME =~ /^(main|dev)$/
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH =~ /^(main|dev)$/
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_TAG =~ /^v\d+\.\d+.*$/
    - if: $CI_PIPELINE_SOURCE == "schedule"
    - if: $CI_PIPELINE_SOURCE == "web"
    - when: never

default:
  image: ai.b-bug.org:5000/k230_sdk:latest
  tags:
    - k230_sdk
  interruptible: true

.markdown_mr_job:
  stage: test
  timeout: 10m
  image: $MARKDOWN_IMAGE
  tags:
    - k230
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME =~ /^(main|dev)$/
  before_script:
    - git fetch origin "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"

.docs_build_job:
  stage: build
  image: $DOCS_BUILDER_IMAGE
  tags:
    - k230
  script:
    - git fetch origin "$DOCS_BRANCH" --tags
    - git checkout -B "$DOCS_BRANCH" "origin/$DOCS_BRANCH"
    - make clean
    - make mhtml
    - mkdir -p "$DOCS_LOCAL_DIR"
    - rm -rf "${DOCS_LOCAL_DIR:?}"/*
    - cp -r _build/. "$DOCS_LOCAL_DIR/"
  artifacts:
    paths:
      - _build
    expire_in: 1 week

.deploy_job:
  stage: deploy
  image: $DEPLOY_IMAGE
  tags:
    - k230
  retry: 2

# MR merged
merge_sync:
  rules:
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "main"
  extends:
    - .setup_env
    - .sync_github_gitee

# tag push
tag_sync:
  rules:
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_TAG =~ /^v\d+\.\d+.*$/
  extends:
    - .setup_env
    - .sync_github_gitee

# auto sync
schedule_sync:
  rules:
    - if: $CI_PIPELINE_SOURCE == "schedule"
  extends:
    - .setup_env
    - .sync_github_gitee

# manual sync
manual_sync:
  rules:
    - if: '$CI_PIPELINE_SOURCE == "web"'
      when: always
  extends:
    - .setup_env
    - .sync_github_gitee

# new MR open
markdown-link-check:
  extends: .markdown_mr_job
  script:
    - git diff --name-only -z --diff-filter=AM "origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...HEAD" -- '*.md' | xargs -0 -r -n1 markdown-link-check -q

# new MR open
markdownlint:
  extends: .markdown_mr_job
  script:
    - git diff --name-only -z --diff-filter=AM "origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME...HEAD" -- '*.md' | xargs -0 -r markdownlint-cli2

.setup_env:
  before_script:
    - test -n "$SSH_PRIVATE_KEY"
    - test -n "$GITLAB_USER_EMAIL"
    - test -n "$GITLAB_USER_NAME"
    - command -v ssh-agent >/dev/null || (apt-get update -y && apt-get install -y openssh-client)
    - eval "$(ssh-agent -s)"
    - mkdir -p ~/.ssh
    - chmod 700 ~/.ssh
    - printf '%s\n' "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add -
    - ssh-keyscan -H github.com g.a-bug.org >> ~/.ssh/known_hosts 2>/dev/null
    - chmod 600 ~/.ssh/known_hosts
    - git config --global user.email "${GITLAB_USER_EMAIL}"
    - git config --global user.name "${GITLAB_USER_NAME}"
    - git config --global --add safe.directory "$CI_PROJECT_DIR"

.sync_github_gitee:
  stage: build
  timeout: 45m
  image: ai.b-bug.org:5000/k230_sdk:latest
  tags:
    - k230_sdk
  script:
    - cd "$CI_PROJECT_DIR"
    - git remote remove github || true
    - git remote add github "${GITHUB_REPO}"
    - git fetch origin main --tags
    - git checkout -B main origin/main
    - |
      for attempt in 1 2 3; do
        git push --atomic --tags -u -f github main && exit 0
        sleep 5
      done
      exit 1

build docs for production:
  extends: .docs_build_job
  rules:
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "main"
  variables:
    DOCS_BRANCH: main
    DOCS_LOCAL_DIR: /data1/k230/k230_rtos_sdk_docs

deploy docs for production:
  extends: .deploy_job
  needs:
    - job: build docs for production
      artifacts: true
  rules:
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "main"
  environment:
    name: production
    url: https://developer.canaan-creative.com/k230_rtos/zh/$CI_COMMIT_BRANCH/index.html
  script:
    - test -n "$AWS"
    - test -n "$AWS_PORT"
    - scp -P "$AWS_PORT" -C -r _build/* "$AWS/data/webapp/k230_rtos"

build docs for development:
  extends: .docs_build_job
  rules:
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "dev"
  variables:
    DOCS_BRANCH: dev
    DOCS_LOCAL_DIR: /data1/k230/k230_rtos_sdk_docs

deploy docs for development:
  extends: .deploy_job
  needs:
    - job: build docs for development
      artifacts: true
  rules:
    - if: $CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "dev"
  environment:
    name: development
    url: https://$DEV_SERVER/k230_rtos/zh/$CI_COMMIT_BRANCH/index.html
  script:
    - mkdir -p /data/webapp/k230_rtos
    - cp -r _build/. /data/webapp/k230_rtos/