sakura editor のビルド用の GitHub Actions を導入する #1259

m-tmatma · 2020-05-03T01:24:22Z

PR の目的

sakura editor のビルド用の GitHub Actions を導入する

カテゴリ

CI関連
- GitHub Actions

GitHub Actions の特徴

GitHub Actions は GitHub 製の CI ツールです。(appveyor や azure pipeline みたいに)
GitHub Actions は同時に 20 個 workflow の実行が可能
GitHub Actions はオープンソースに対してはフリー
GitHub Actions の artifacts の保存期間は 90 日
GitHub Actions は GitHub アカウントがあれば利用可能
GitHub Actions は GitHub ユーザー自身が GitHubアクションを作成、公開、利用可能
GitHub Actions は GitHub 製のGitHubアクションも GitHub で公開されているので必要に応じて PR を送ることも可能

PR の背景

sakura-editor/sakura-editor.github.io#6 で doxygen の管理をどうするか検討する中で、GitHub Actions を使えないか検討を行っていた。

その結果、sakura-editor/sakura-editor.github.io#24 や sakura-editor/sakura-editor.github.io#25 でも GitHub Actions で GitHub Pages に展開できそうなので、GitHub Actions の調査を行っていた。

いろいろ調べたところ GitHub Actions は非常に強力なので、すでに使われている appveyor や Azure Pipelines に加えて導入してみたらいいんじゃないかと思い、実験してみたところ動作したので、導入してみようと思います。

いろいろ修正したほうがいいところはあると思いますが、最初に導入するレベルとしてはいいのではないかと思います。

注意

※ この PR では GitHub Actions のビルドは走っていませんが、いったん master にマージされればこのリポジトリで GitHub Actions が有効になり、以降の PR で有効になると考えられます。

PR のメリット

GitHub Actions を使ってみて、いろいろ試すきっかけになる
Appveyor や Azure Pipelines と異なり、別途アカウントを作成しなくても GitHub ユーザーなら自動的に使える

PR のデメリット (トレードオフとかあれば)

なし

未実装なところ

ドキュメント
Azure Pipelines や Appveyor ビルドで取得している各種環境変数 (Appveyor 専用の環境変数を汎用的なものに定義しなおして azure pipelines で使えるようにする #1183) には対応していない
v2.4のヘルプキーワード検索画面のリストが文字化けしている #922 には対応できないので、chm および installer のビルドは無効化している
Artifacts が一括して一つの zip にまとめられるが、個別にダウンロードできるようにする
microsoft/setup-msbuild@v1.0.0 で自動的に Visual Studio 2019 が選択される。
~~paths-ignore を使って md ファイルや appveyor や azure pipelines の固有ファイルの更新無視~~

PR の影響範囲

なし

参考資料

https://github.co.jp/features/actions
https://help.github.com/ja/actions/getting-started-with-github-actions/about-github-actions

m-tmatma · 2020-05-03T01:30:01Z

説明欄の PR の背景を訂正

m-tmatma · 2020-05-03T01:31:43Z

この PR に含まれていないのは https://github.com/sakura-editor/sakura にはまだ設定ファイルが取り込まれていないためだと思う。

https://github.com/m-tmatma/sakura/actions
では特に設定を行わなくてもビルドされた。

m-tmatma · 2020-05-03T01:38:13Z

.github/workflows/build-sakura.yml

+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    - uses: actions/checkout@v2


メモ

actions/checkout は https://github.com/actions/checkout でソースが公開されている GitHub 純正の GitHub Action です。ソースを checkout します。

@v2 というのは actions/checkout のバージョンです。

雑談

「謹製」に関して
https://suzumi-ya.com/epub/post-990/

AppVeyorBot · 2020-05-03T01:44:38Z

✅ Build sakura 1.0.2746 completed (commit 9bb5912853 by @m-tmatma)

m-tmatma · 2020-05-03T01:45:34Z

.github/workflows/build-sakura.yml

+      uses: actions/upload-artifact@v2
+      with:
+        name: exe ${{ matrix.platform }} ${{ matrix.config }}
+        path: '*.zip'


メモ

パス名の部分で wildcard が使えるのは actions/upload-artifact@v2 以降。
actions/upload-artifact@v1 では使えなくて悩んだ。

m-tmatma · 2020-05-03T01:46:31Z

.github/workflows/build-sakura.yml

+    - uses: actions/checkout@v2
+
+    - name: Add msbuild to PATH
+      uses: microsoft/setup-msbuild@v1.0.0


現状では msbuild に対してバージョン指定してないので Visual studio 2019 が使われる

https://github.com/microsoft/setup-msbuild
の markdown 参照

k-takata · 2020-05-03T01:50:54Z

この PR に含まれていないのは https://github.com/sakura-editor/sakura にはまだ設定ファイルが取り込まれていないためだと思う。

pull_request: のブランチが master と release/* に制限されているからでしょう。

m-tmatma · 2020-05-03T01:57:26Z

pull_request: のブランチが master と release/* に制限されているからでしょう。

追加してみたけど変化ありませんでした。

https://help.github.com/ja/actions/reference/workflow-syntax-for-github-actions
を確認したところ、以下となっており、pull_request で指定するのはマージ先のようです。

on.<push|pull_request>.<branches|tags>
pushおよびpull_requestイベントを使用する場合、特定のブランチまたはタグで
実行するワークフローを設定できます。 pull_requestでは、ベース上のブランチ
及びタグだけが評価されます。 tagsもしくはbranchesだけを定義すると、
定義されていないGit refに影響するイベントに対して、ワークフローが実行されません。

k-takata · 2020-05-03T02:04:31Z

ありゃ、違ってましたか。すんません。
ベースブランチで既に GHA が有効化されてないと動かないのかな。

m-tmatma · 2020-05-03T02:10:55Z

この PR に含まれていないのは https://github.com/sakura-editor/sakura にはまだ設定ファイルが取り込まれていないためだと思う。

ちなみに別のリポジトリで試しているものでは PR に対して実行されています。
test-sakura-editor#1

こちらは master に対して実行する設定ファイルが master に含まれています。

AppVeyorBot · 2020-05-03T02:12:54Z

✅ Build sakura 1.0.2747 completed (commit 704ea0ebf2 by @m-tmatma)

AppVeyorBot · 2020-05-03T02:52:57Z

✅ Build sakura 1.0.2748 completed (commit 491a4335cf by @m-tmatma)

k-takata · 2020-05-03T03:18:22Z

権限がない人からのPRだとダメだけど、権限があればPRで設定ファイルを追加しても行けるとか？

m-tmatma · 2020-05-03T03:45:10Z

権限がない人からのPRだとダメだけど、権限があればPRで設定ファイルを追加しても行けるとか？

どういうことですか？
どちらのリポジトリでも、私は、書き込み権限あります。

berryzplus · 2020-05-03T03:57:40Z

これがナニをするものか、未知の領域なので判断付かない感じです。

雰囲気、便利そう。
なんかあったらそれは別に対応したらいいじゃないか。

ということで異論なしっす。

m-tmatma · 2020-05-03T04:00:14Z

これがナニをするものか、未知の領域なので判断付かない感じです。

GitHub Actions は GitHub 製の CI ツールです。(appveyor や azure pipeline みたいに)
説明欄に記載しました。

k-takata · 2020-05-03T04:43:42Z

どちらのリポジトリでも、私は、書き込み権限あります。

書き込み権限があってもowner権限がないと多分ダメなのではないかと。

m-tmatma · 2020-05-03T05:25:09Z

owner権限も両方あります。
単純にマージ対象のブランチに設定ファイルが、入ってないのが、
原因かと思います

k-takata · 2020-05-03T08:18:11Z

どちらのリポジトリもベースブランチに設定ファイルが無い状態なのに違いが出たという話だと勘違いしてました。

berryzplus

入れてみないと分からん気配なので、入れて試してみましょう。
変なことは起きないと思いますが、なんか起きたらrevert含め対処する感じでお願い:smile:

m-tmatma · 2020-05-03T08:59:36Z

マージしたらビルド走りました
https://github.com/sakura-editor/sakura/actions/runs/94359619

berryzplus · 2020-05-03T16:54:12Z

このPRをマージしたあとの master をベースにしたブランチを push できませんでした。
rebase して push しちゃったので詳細見てなかったんですが、なんか設定が必要になる系？
（失敗したpushは自分とこ https://github.com/berryzplus/sakura 宛てでした。）

手順を踏めばなんとかなるようなら問題だとは思わない感じです。
う～ん、やっぱり出るなぁ・・・。

git.exe push --set-upstream --progress "origin" feature/github_actions_test
Enumerating objects: 9, done.
Counting objects: 100% (9/9), done.
Delta compression using up to 16 threads
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 494 bytes | 494.00 KiB/s, done.
Total 5 (delta 4), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
To https://github.com/berryzplus/sakura.git
! [remote rejected]     feature/github_actions_test -> feature/github_actions_test (refusing to allow an OAuth App to create or update workflow `.github/workflows/build-sakura.yml` without `workflow` scope)
error: failed to push some refs to 'https://github.com/berryzplus/sakura.git'


git did not exit cleanly (exit code 1) (5625 ms @ 2020/05/04 1:52:54)

berryzplus · 2020-05-04T04:02:13Z

放置かいっ！ｗ

このメッセージがエラー原因のように見えました。

! [remote rejected] feature/github_actions_test -> feature/github_actions_test (refusing to allow an OAuth App to create or update workflow .github/workflows/build-sakura.yml without workflow scope)
error: failed to push some refs to 'https://github.com/berryzplus/sakura.git'

workflow スコープがどうたらってとこと、OAuth App がどうたらってとこがヒントなのかな？

その辺の手順というか、「前提としてこういう設定が必要」みたいな情報が欲しいです。
おいらのとこのリポジトリは、まだなんも設定しとらん状態なので。

m-tmatma · 2020-05-04T04:12:59Z

放置かいっ！ｗ

気づかなかった。

rebase して push しちゃったので詳細見てなかったんですが、なんか設定が必要になる系？

rebase して push した場合 --force または --force-with-lease が必要です。
ただ、いまいち何をしたのかがわからないです。

m-tmatma · 2020-05-04T04:21:21Z

ただ、いまいち何をしたのかがわからないです。

なお、tortoisegit を使うと履歴を視覚的に表示してくれるので便利です。
https://tortoisegit.org/docs/tortoisegit/tgit-dug-revgraph.html

berryzplus · 2020-05-04T05:18:22Z

ただ、いまいち何をしたのかがわからないです。

すみません、分かるように書いていませんでした。

現master(2c77cc7) をベースにコミットを積んでローカルブランチを作った。
自分のとこのリポジトリ(https://github.com/berryzplus/sakura.git) に push しようとしたら、なんかエラーが出た（詳細見てない）
よくわからんので一個前のmaster(d2a5a15)にリベースした。
自分のとこのリポジトリ(https://github.com/berryzplus/sakura.git) に pushできた　⇒　https://github.com/berryzplus/sakura/tree/feature/fix_mailaddress_detection
原因わからずじまいでキモいので現master(2c77cc7) をベースにコミットを積んでローカルブランチを作った。feature/github_actions_test
自分のとこのリポジトリ(https://github.com/berryzplus/sakura.git) に push しようとしたらなんかエラーが出た（sakura editor のビルド用の GitHub Actions を導入する #1259 の「やっぱり出るなぁ」以降のログが出力された。）

k-takata · 2020-05-04T05:54:59Z

(refusing to allow an OAuth App to create or update workflow .github/workflows/build-sakura.yml without workflow scope)

github の認証はどうやってますか？ sshを使っているのならば何も設定する必要はないはずですが、エラーメッセージから察するに、httpsでパスワードにpersonal access tokenを使っているのだとしたら、workflow スコープにチェックを入れてtokenを作り直す必要があると思います。

m-tmatma · 2020-05-04T07:03:49Z

(refusing to allow an OAuth App to create or update workflow .github/workflows/build-sakura.yml without workflow scope)

github の認証はどうやってますか？ sshを使っているのならば何も設定する必要はないはずですが、エラーメッセージから察するに、httpsでパスワードにpersonal access tokenを使っているのだとしたら、workflow スコープにチェックを入れてtokenを作り直す必要があると思います。

最初これを読んで意味がわからなかったです。

https://github.com/settings/tokens/new で token 作るときに workflow にチェックをつけて token を作ったものを指定するということですね。 @k-takata

参考
https://github.community/t5/GitHub-Actions/Refusing-to-allow-an-integration-to-create-or-update/td-p/32472

berryzplus · 2020-05-04T07:33:14Z

github の認証はどうやってますか？

設定するのがめんどくて https:// のパスワード認証です。

sshを使っているのならば何も設定する必要はないはずですが、エラーメッセージから察するに、httpsでパスワードにpersonal access tokenを使っているのだとしたら、workflow スコープにチェックを入れてtokenを作り直す必要があると思います。

ふむむ...
単にアクセスプロトコルを git: にしたら動くのかな？

OAuth で思いついて GitHub の Settings にある Authorized Apps をチェックしてみたら GitHub Actions は居ませんでした（＝たぶんこれ、Authorizedになってない... ）

もうちょっと見て見ます。

m-tmatma · 2020-05-04T09:33:35Z

OAuth で思いついて GitHub の Settings にある Authorized Apps をチェックしてみたら GitHub Actions は居ませんでした（＝たぶんこれ、Authorizedになってない... ）

https://github.com/settings/tokens
はどうなっていますか?

berryzplus · 2020-05-04T11:43:26Z

普通に書き間違ってたんですけど RSA鍵 を登録して ssh接続 するようにしたらpushできました。（git: って書いてますが、元からSSH接続を設定するつもりでした。用語、超ぁゃしぃ...

https://github.com/settings/tokens
はどうなっていますか?

モバイル用に作成した token が3つほど登録されております...。
試しに workflow の権限付けてみたら push が成功しました。

というわけで、おいらの問題は解決っす。
ありがとうございます。

…-github-actions-sakura-build sakura editor のビルド用の GitHub Actions を導入する

m-tmatma added 2 commits May 3, 2020 09:53

sakura editor のビルド用の GitHub Actions を導入する

8d1c95c

sakura-editor#922 のために chm, installer ビルドを無効化

923992e

m-tmatma added the CI appveyor など CI 関連【ChangeLog除外】 label May 3, 2020

m-tmatma commented May 3, 2020

View reviewed changes

feature/* を追加

9ae4f5e

m-tmatma mentioned this pull request May 3, 2020

雑談場Part5 sakura-editor/management-forum#74

Closed

GitHub Actions 関連のファイルを azure pipelines と appveyor のビルド対象から外す

72bcb28

コメント追加

331543f

paths-ignore を実装

c8d2253

berryzplus approved these changes May 3, 2020

View reviewed changes

m-tmatma merged commit 2c77cc7 into sakura-editor:master May 3, 2020

m-tmatma mentioned this pull request May 3, 2020

[WIP] GitHub Actions のテスト #1262

Closed

m-tmatma deleted the feature/introduce-github-actions-sakura-build branch May 3, 2020 08:59

m-tmatma mentioned this pull request May 4, 2020

GitHub Actions を導入する #1263

Closed

5 tasks

m-tmatma mentioned this pull request May 9, 2020

GitHub Actions の成果物を別々の ZIP として upload する #1285

Merged

HoppingTappy pushed a commit to HoppingTappy/sakura that referenced this pull request Jun 16, 2020

Merge pull request sakura-editor#1259 from m-tmatma/feature/introduce…

26b8b34

…-github-actions-sakura-build sakura editor のビルド用の GitHub Actions を導入する

This was referenced Jan 11, 2021

Azure PipelinesのPRビルドの除外パスが漏れていたのを追加する #1498

Merged

Azure Pipelinesの除外パス指定が機能していなかったのを修正する #1500

Merged

berryzplus mentioned this pull request Jan 11, 2021

Azure Pipelinesの除外パス指定が機能していないらしい #1501

Closed

This was referenced May 9, 2021

GitHub Actions の環境変数に対応する #1664

Closed

GitHub Actions の環境変数をビルドで利用できるようにする #1669

Merged

ghost mentioned this pull request Feb 24, 2022

利用するCI/CDサービスをGitHub Actionsに一本化する #1809

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sakura editor のビルド用の GitHub Actions を導入する #1259

sakura editor のビルド用の GitHub Actions を導入する #1259

m-tmatma commented May 3, 2020 •

edited

Loading

m-tmatma commented May 3, 2020

m-tmatma commented May 3, 2020

m-tmatma May 3, 2020 •

edited

Loading

m-tmatma May 3, 2020

AppVeyorBot commented May 3, 2020

m-tmatma May 3, 2020

m-tmatma May 3, 2020 •

edited

Loading

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020 •

edited

Loading

AppVeyorBot commented May 3, 2020

AppVeyorBot commented May 3, 2020

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020

berryzplus commented May 3, 2020

m-tmatma commented May 3, 2020 •

edited

Loading

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020 •

edited

Loading

k-takata commented May 3, 2020

berryzplus left a comment

m-tmatma commented May 3, 2020

berryzplus commented May 3, 2020

berryzplus commented May 4, 2020

m-tmatma commented May 4, 2020 •

edited

Loading

m-tmatma commented May 4, 2020

berryzplus commented May 4, 2020

k-takata commented May 4, 2020

m-tmatma commented May 4, 2020

berryzplus commented May 4, 2020

m-tmatma commented May 4, 2020

berryzplus commented May 4, 2020

sakura editor のビルド用の GitHub Actions を導入する #1259

sakura editor のビルド用の GitHub Actions を導入する #1259

Conversation

m-tmatma commented May 3, 2020 • edited Loading

PR の目的

カテゴリ

GitHub Actions の特徴

PR の背景

注意

PR のメリット

PR のデメリット (トレードオフとかあれば)

未実装なところ

PR の影響範囲

関連チケット

参考資料

m-tmatma commented May 3, 2020

m-tmatma commented May 3, 2020

m-tmatma May 3, 2020 • edited Loading

Choose a reason for hiding this comment

m-tmatma May 3, 2020

Choose a reason for hiding this comment

AppVeyorBot commented May 3, 2020

m-tmatma May 3, 2020

Choose a reason for hiding this comment

m-tmatma May 3, 2020 • edited Loading

Choose a reason for hiding this comment

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020 • edited Loading

AppVeyorBot commented May 3, 2020

AppVeyorBot commented May 3, 2020

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020

berryzplus commented May 3, 2020

m-tmatma commented May 3, 2020 • edited Loading

k-takata commented May 3, 2020

m-tmatma commented May 3, 2020 • edited Loading

k-takata commented May 3, 2020

berryzplus left a comment

Choose a reason for hiding this comment

m-tmatma commented May 3, 2020

berryzplus commented May 3, 2020

berryzplus commented May 4, 2020

m-tmatma commented May 4, 2020 • edited Loading

m-tmatma commented May 4, 2020

berryzplus commented May 4, 2020

k-takata commented May 4, 2020

m-tmatma commented May 4, 2020

berryzplus commented May 4, 2020

m-tmatma commented May 4, 2020

berryzplus commented May 4, 2020

m-tmatma commented May 3, 2020 •

edited

Loading

m-tmatma May 3, 2020 •

edited

Loading

m-tmatma May 3, 2020 •

edited

Loading

m-tmatma commented May 3, 2020 •

edited

Loading

m-tmatma commented May 3, 2020 •

edited

Loading

m-tmatma commented May 3, 2020 •

edited

Loading

m-tmatma commented May 4, 2020 •

edited

Loading