docC github pages deploy

DocC Github Pages デプロイ: 生成された DocC 静的サイトを Github-Pages にデプロイします。

• 要件
• 使用法
• 統合
• 貢献者
• ライセンス

要件

プラットフォーム	状態
ubuntu-最新	テスト済み

使用法

action.yml を参照してください。

必ずバージョンを最新のタグに設定してください。

例として:

 name : worksapce
on :
  push :
    branches :
      - ' ** '
jobs :
  build_deploy_site :
    runs-on : ubuntu-latest
    environment :
      name : github-pages
      url : ${{ steps.deployment.outputs.page_url }}

    permissions :
      pages : write
      contents : read
      id-token : write

    steps :
    - name : deploy static site
      uses : kiarashvosough1999/[email protected]

必ずpages 、 contents 、およびid-tokenへのアクセスを許可してください。そうしないと、アクションはサイトを Github-Pages にプッシュできません。

例のように環境上でnameとurl必ず指定してください。指定しない場合、ジョブは失敗します。

Build DocC 静的サイトとの統合

build-docC-static-site を使用して、DocC アーカイブから静的サイトを生成できます。

build-docC-static-site に関連付けられたデフォルトのdocC-generated-static-site-uploaded-nameと、このアクションに関連付けられたdocC-generated-static-site-zipped-upload-name入力は同じである必要があります。

このアクションにより、入力静的サイトがgtarおよびtar拡張子で解凍されます。したがって、 docC-generated-static-site-uploaded-nameまたはdocC-generated-static-site-zipped-upload-nameに zip 拡張子を指定しないでください。

貢献者

アイデアやその他の問題をお気軽に共有してください。プルリクエストは歓迎されます。

ライセンス

docC-github-pages-deploy は、MIT ライセンスに基づいてリリースされています。詳細については、「ライセンス」を参照してください。