README

此库可以将Markdown格式的文档上传到HelpScout Docs。

文档格式： https://wpdesk.slab.com/posts/dokumentacja-w-git-labie-zwqmz8lk

要求

库需要PHP 7.4。

API密钥

应使用具有所有者权限的HS账户生成。获取密钥的说明请见此处 https://developer.helpscout.com/docs-api/

网站ID

从HelpScout管理员URL获取。例如，当文档URL为 https://secure.helpscout.net/settings/docs/site/5f8566584cedfd0017dd1112 时，网站ID为 5f8566584cedfd0017dd1112

用法

此代码使用命令行中的 HELPSCOUT_API_KEY/HELPSCOUT_DOCS_SITE_ID，如果没有提供命令行参数，则从Gitlab CI变量中获取。

<?php
require_once __DIR__ . '/vendor/autload.php';

$apiKey = empty($argv[1]) ? $_SERVER['HELPSCOUT_API_KEY'] : $argv[1];
$docsSite = empty($argv[2]) ? $_SERVER['HELPSCOUT_DOCS_SITE_ID'] : $argv[2];

(new \WPDesk\HsSync\SyncRunner($apiKey, $docsSite, __DIR__))
    ->run();

简单的Gitlab CI脚本

stages:
  - sync

before_script:
  - mv "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
  - cd hs-sync
  - apt-get update && apt-get install -y libzip-dev git
  - docker-php-ext-install zip
  - php -r "copy('https://getcomposer.org/download/1.10.6/composer.phar', 'composer.phar');"
  - php composer.phar install --no-dev

sync with hs prod:
    tags:
      - deploy
    image: php:7.4-cli
    stage: sync
    script:
      - php sync.php
    only:
      - master