gh-actions
**文書の過去の版を表示しています。**
Error loading plugin markdowku
Error: Class "dokuwiki\Parsing\Handler\Quote" not found
More info is available in the error log.
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を作成したタイミングや、任意のワークフローからAPIを呼び出すことで、手動でVersionを追加する手間を省くことができます。
機能概要
GitHub ActionsからModParks APIを呼び出すことで、プロジェクトへVersionを登録できます。
- GitHub Releaseの作成後に自動でVersionを登録できます。
- 任意のタイミングでワークフローから登録できます。
- ダウンロードURLを指定するだけで、ModParksがファイルを取得します。
- ChangelogやMinecraftバージョン、ローダー情報も同時に登録できます。
事前準備
利用するには以下が必要です。
- ModParksでプロジェクトを作成していること
- APIキーを発行していること
- GitHubリポジトリの Secrets and variables → Actions に
MODPARKSAPIKEYとしてAPIキーを登録していること
GitHub Actions の例
Release作成時に自動登録する例です。
- 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=1.21.6" \ -F "loaders=fabric" \ -F "changelog=${{ github.event.head_commit.message }}" \ -F "fileUrl=$FILE_URL" ```
パラメータ
| 項目 | 説明 |
|---|---|
versionNumber | 登録するバージョン番号 |
mcVersions | 対応Minecraftバージョン(複数指定可能) |
loaders | 対応Modローダー(複数指定可能) |
changelog | 変更履歴 |
fileUrl | ダウンロード可能な .jar または .zip のURL |
注意事項
fileUrlはModParksサーバーからアクセスできる公開URLである必要があります。mcVersionsとloadersは複数指定できます。- APIキーは公開せず、必ずGitHub Secretsから参照してください。
- Version番号が既に存在する場合は登録できません。
gh-actions.1785678689.txt.gz · 最終更新: by admin
