https://github.com/techiro/release-test
test for release
https://github.com/techiro/release-test
Last synced: about 1 month ago
JSON representation
test for release
- Host: GitHub
- URL: https://github.com/techiro/release-test
- Owner: techiro
- Created: 2025-01-30T23:38:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-27T00:54:18.000Z (3 months ago)
- Last Synced: 2026-04-30T16:36:06.154Z (about 1 month ago)
- Language: Shell
- Size: 174 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changes.md
Awesome Lists containing this project
README
# Project Documentation
Last updated: 2025-05-21
## Features
- Automated version management
- CI/CD pipeline integration
- Release note generation
- GitHub Actions workflow examples
- Repository integration via repository_dispatch
## Inter-Repository Integration
### Triggering workflow from release-test-server
This repository can be updated automatically when changes are made in the [release-test-server](https://github.com/techiro/release-test-server/) repository. The integration uses GitHub's `repository_dispatch` event and can be triggered using the following methods:
#### Required GitHub App Configuration
The workflow now uses a GitHub App for cross-repository operations. This approach is more secure and maintainable than using personal access tokens:
1. Create a GitHub App with appropriate permissions for both repositories
2. Generate a private key for the app
3. Configure the repository with:
- Repository secret: `RELEASE_INTEGRATION_APP_PRIVATE_KEY` - The app's private key
- Repository variable: `RELEASE_INTEGRATION_APP_ID` - The app's ID
For detailed setup instructions, see [GitHub App Setup Guide](docs/github-app-setup.md).
#### Using GitHub CLI
```bash
gh api repos/techiro/release-test/dispatches \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
-f event_type=server-update \
-f client_payload='{
"ref": "main",
"repository": "techiro/release-test-server",
"sha": "commit-sha-here",
"message": "Update from server repository"
}'
```
#### Using curl
```bash
curl -X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token GITHUB_TOKEN" \
https://api.github.com/repos/techiro/release-test/dispatches \
-d '{
"event_type": "server-update",
"client_payload": {
"ref": "main",
"repository": "techiro/release-test-server",
"sha": "commit-sha-here",
"message": "Update from server repository"
}
}'
```
#### From GitHub Actions in release-test-server
```yaml
name: Trigger release-test update
on:
push:
branches: [ main ]
jobs:
trigger-update:
runs-on: ubuntu-latest
steps:
- name: Trigger repository_dispatch event
run: |
curl -X POST \
-H "Accept: application/vnd.github.v3+json" \
-H "Authorization: token ${{ secrets.REPO_ACCESS_TOKEN }}" \
https://api.github.com/repos/techiro/release-test/dispatches \
-d '{
"event_type": "server-update",
"client_payload": {
"ref": "${{ github.ref_name }}",
"repository": "${{ github.repository }}",
"sha": "${{ github.sha }}",
"message": "Update from ${{ github.repository }} (${{ github.sha }})"
}
}'
```
## Debugging
### actコマンドを使用したワークフローのローカル実行
```bash
brew install act
```
#### 基本的な使い方
1. Dockerデーモンを実行する：`open -a Docker`
2. ワークフローのリストを表示する：`act -l`
3. 特定のジョブを実行する：`act -j JOB_NAME`（例：`act push -j check-date`）
4. 詳細なログを表示する：`act -v -j JOB_NAME`
#### イベントタイプ別の実行方法
以下のイベントタイプでワークフローを実行できます：
1. プッシュイベント：`act push`
2. プルリクエストイベント：`act pull_request`
3. 手動トリガー（workflow_dispatch）：`act workflow_dispatch`
4. スケジュールイベント：`act schedule`
5. リポジトリディスパッチイベント：`act repository_dispatch -e repository_dispatch_event.json`
#### event.jsonを使ったイベントデータの指定
カスタムイベントデータを使用してワークフローを実行する場合は、`-e`または`--eventpath`オプションを使用します：
1. 標準の`event.json`を使用する場合：`act workflow_dispatch -e event.json`
2. カスタムイベントファイルを使用する場合：`act issue_comment -e issue_comment_event.json`
3. リポジトリディスパッチイベントの場合：`act repository_dispatch -e repository_dispatch_event.json`
4. 特定のジョブのみを実行する場合：`act workflow_dispatch -e event.json -j JOB_NAME` (例: `act issue_comment -e issue_comment_event.json -j deploy-command`)
#### 秘密情報と環境変数の設定
actでは`.actrc`ファイルと`.env`ファイルを使用して秘密情報や環境変数を設定できます：
1. `.env`ファイルの設定方法：
```bash
# トークンを直接設定
GITHUB_TOKEN=ghp_your_token_here
RELEASE_INTEGRATION_APP_ID=your_app_id_here
# 複数行の秘密鍵を設定
RELEASE_INTEGRATION_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
MII...
...
-----END RSA PRIVATE KEY-----"
```
2. 環境変数を使用してactを実行：
```bash
# .envファイルからシークレット変数を読み込んで実行
act --secret-file .env workflow_dispatch
# .env.var ファイルから変数を読み込んで実行
act --secret-file .env --var-file .env.var workflow_dispatch -j generate-token -s GITHUB_TOKEN="$(gh auth token)"
```