doc-sync/action.yml at main · Actx0/doc-sync · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
name: Sync docs to Actx0 knowledge
description: Upload repository docs to an Actx0 workspace knowledge base, skipping files whose checksum already matches.
author: Actx0
branding:
  icon: book-open
  color: blue

inputs:
  workspace_id:
    description: Actx0 workspace ID
    required: true
  access_key:
    description: Actx0 access key
    required: true
  tags:
    description: "Knowledge labels as a YAML map, one key: value per line"
    required: false
    default: ""
  paths:
    description: "Files, directories, or globs to sync, one per line. Directories include markdown and text files."
    required: true
  repo_dir:
    description: Repository root used to resolve paths
    required: false
    default: ${{ github.workspace }}
  base_url:
    description: Actx0 API base URL
    required: false
    default: https://app.actx0.com
  dry_run:
    description: Compare checksums and print actions without uploading or deleting
    required: false
    default: "false"

outputs:
  uploaded:
    description: Number of new documents uploaded
    value: ${{ steps.sync.outputs.uploaded }}
  replaced:
    description: Number of documents replaced after a checksum change
    value: ${{ steps.sync.outputs.replaced }}
  skipped:
    description: Number of documents skipped because the checksum already matched
    value: ${{ steps.sync.outputs.skipped }}
  failed:
    description: Number of documents that failed to sync
    value: ${{ steps.sync.outputs.failed }}

runs:
  using: composite
  steps:
    - name: Set up Go
      if: ${{ !startsWith(github.action_ref, 'v') }}
      uses: actions/setup-go@v5
      with:
        go-version-file: ${{ github.action_path }}/go.mod
        cache-dependency-path: ${{ github.action_path }}/go.sum

    - name: Install doc-sync
      id: install
      shell: bash
      env:
        DOC_SYNC_REPO: ${{ github.action_repository }}
        DOC_SYNC_REF: ${{ github.action_ref }}
        DOC_SYNC_ACTION_PATH: ${{ github.action_path }}
        DOC_SYNC_BIN: ${{ runner.temp }}/actx0-doc-sync
        GH_TOKEN: ${{ github.token }}
      run: bash "${{ github.action_path }}/script/install.sh"

    - name: Sync knowledge
      id: sync
      shell: bash
      env:
        INPUT_WORKSPACE_ID: ${{ inputs.workspace_id }}
        INPUT_ACCESS_KEY: ${{ inputs.access_key }}
        INPUT_TAGS: ${{ inputs.tags }}
        INPUT_PATHS: ${{ inputs.paths }}
        INPUT_REPO_DIR: ${{ inputs.repo_dir }}
        INPUT_BASE_URL: ${{ inputs.base_url }}
        INPUT_DRY_RUN: ${{ inputs.dry_run }}
      run: |
        "${{ steps.install.outputs.bin }}"