ユーザ用ツール

サイト用ツール


gh-actions

**文書の過去の版を表示しています。**

Error loading plugin markdowku
Error: Class "dokuwiki\Parsing\Handler\Quote" not found
More info is available in the error log.

GitHub Actions 連携

ModParksでは、GitHub ActionsからAPIを利用して、新しいVersionを自動的に登録できます。

GitHub Releaseの公開に合わせてワークフローを実行することで、手動でVersionを追加する手間を省くことができます。

機能概要

GitHub ActionsからModParks APIを呼び出すことで、プロジェクトへVersionを登録できます。

  • GitHub Releaseの公開後に自動でVersionを登録できます。
  • ダウンロードURLを指定することで、ModParksがファイルを取得します。
  • Minecraftバージョンやローダー、変更履歴も同時に登録できます。

事前準備

利用するには、以下の準備が必要です。

  • ModParksでプロジェクトを作成していること
  • APIキーを発行していること
  • GitHubリポジトリの SettingsSecrets and variablesActionsMODPARKSAPIKEY としてAPIキーを登録していること

GitHub Actions の設定

以下は、GitHub Releaseの作成後にVersionを登録するワークフローの例です。

- name: Register to ModParks
  env:
    MODPARKS_URL: https://modparks.pitan76.net
    PROJECT_SLUG: your-project
    VERSION_NUMBER: ${{ github.ref_name }}
  run: |
    FILE_NAME=$(basename build/libs/*.jar)
    FILE_URL="https://github.com/${{ github.repository }}/releases/download/${VERSION_NUMBER}/${FILE_NAME}"

```
curl -X POST "$MODPARKS_URL/api/v1/projects/$PROJECT_SLUG/versions" \
  -H "Authorization: Bearer ${{ secrets.MODPARKS_API_KEY }}" \
  -F "versionNumber=$VERSION_NUMBER" \
  -F "mcVersions=your-minecraft-version" \
  -F "loaders=fabric" \
  -F "changelog=${{ github.event.head_commit.message }}" \
  -F "fileUrl=$FILE_URL"
```

mcVersions および loaders は複数指定できます。

注意事項

  • fileUrl はModParksサーバーからアクセス可能な公開URLである必要があります。
  • APIキーはGitHub Secretsを利用し、ワークフロー内へ直接記述しないでください。
  • 同じバージョン番号が既に登録されている場合は、新しく登録できません。
  • 詳細なAPI仕様についてはAPIリファレンスを参照してください。
gh-actions.1785678763.txt.gz · 最終更新: by admin