Merge pull request #179 from vim-jp/create-releasae-using-gha-175

Add a workflow for creating release

Author: koron

.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Create a release
+
+on:
+  push:
+    branches: [ '**' ]
+    tags:
+    - '[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]'
+    - '[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]-alpha.*'
+    - '[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]-beta.*'
+
+jobs:
+  release:
+
+    runs-on: ubuntu-24.04
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v6
+
+    - name: Install packages
+      run: |
+        sudo apt install gettext vim
+
+    - name: Create an archive
+      run: |
+        make release ARCHIVE=vim-lang-ja-${{ github.ref_name }}
+
+    - name: Upload the archive
+      uses: actions/upload-artifact@v6
+      with:
+        name: vim-lang-ja
+        path:
+          vim-lang-ja-*.tar.xz
+
+    # リリース(draft)を作成しファイルを添付する
+    - name: Create a release
+      if: startsWith(github.ref, 'refs/tags/')
+      uses: softprops/action-gh-release@a06a81a03ee405af7f2048a818ed3f03bbf83c7b # v2.5.0
+      with:
+        draft: true
+        prerelease: ${{ contains(github.ref_name, '-alpha.') || contains(github.ref_name, '-beta.') }}
+        files: |
+          vim-lang-ja-*.tar.xz
+        fail_on_unmatched_files: true
+        generate_release_notes: true
+        append_body: true

README.md

@@ -50,7 +50,7 @@ nsis/lang                          |Windows用インストーラーの翻訳フ
 
     Windows 上で vim.pot を生成するには、Cygwin や MSYS2 等の Linux 的な環境を
     使うこと。(MSVC 用の Makefile も用意されているが、ソースファイルの読み込み
-    順序が異なるために余計な差分が出てしまう。)  
+    順序が異なるために余計な差分が出てしまう。)
     また、古いソースを使って Win32 向けにビルドしたことで `src/if_perl.c` が
     残っているならば、vim.pot 生成前に削除しておくこと。(余計な差分が出るのを
     防ぐため。)
@@ -190,6 +190,11 @@ nsis/lang                          |Windows用インストーラーの翻訳フ
 
 ## リリース手順
 
+リリースにはリリースアーカイブの作成と、Vimへの反映(PR作成)がある。
+どちらも GitHub の master ブランチへ反映させるところまでは共通の手順となる。
+
+### 共通手順: master ブランチを更新する
+
 1.  各リソースが最新に近いことを確認する
 
     TODO: 将来、より具体的で自動化された手段を提供したい
@@ -205,27 +210,51 @@ nsis/lang                          |Windows用インストーラーの翻訳フ
     [CI][#ci] で実行しているのでローカルでやる意味は無いが、テストをパスするこ
     とを確認する。
 
-4.  リリース用アーカイブを作成する
+4.  変更を master ブランチへ反映させる
+
+    必要に応じてPRしてマージ、もしくは直接 push して master ブランチをリリース
+    できる状態にする。
+
+### リリースアーカイブの作成
+
+リリースアーカイブの作成はタグ付けにより駆動する GitHub Actions ワークフローを
+用いる。
+
+1.  master ブランチ上でタグ(`YYYYMMDD`)を作成し、GitHub へ push する
+
+    ```console
+    $ git switch master
+
+    # 日付ベースのタグを打つ
+    $ git tag -am '{リリースコメント}' 20260323
+
+    # タグを GitHub へpush
+    $ git push origin 2060323
+    ```
+
+    有効なタグのフォーマットは以下のいずれか。
+    下2つについてはあとのステップで作成されるリリースが、
+    自動的に pre-release としてマークされる。
 
-        $ make release-today
+    -   `^\d\d\d\d\d\d\d\d$`
+    -   `^\d\d\d\d\d\d\d\d-alpha\..*$`
+    -   `^\d\d\d\d\d\d\d\d-beta\..*$`
 
-    `vim-lang-ja-20160131.tar.xz` といったアーカイブファイルができる。
-    `20160131` の部分は実行した日付に置き換わる。
+2.  GitHub Actions の [Releaseワークフロー][#release-workflow] が終わるのを待つ
 
-    前回のリリースから、`*.po` 以外のファイルが更新されていない場合は、po
-    のみのリリース用アーカイブを作成する。(Bram の要請。)
+3.  ドラフト状態のリリースを、適宜編集し公開(ドラフト解除)する
 
-        $ cd src/po/
-        $ make release-today
+    リリースアーカイブは前ステップが添付してくれている。
 
-    `vim-lang-ja-po-YYYYMMDD.tar.xz` といったアーカイブファイルができる。
-    `YYYYMMDD` の部分は実行した日付に置き換わる。
+### Vimへの反映
 
-5.  Vim のソースディレクトリを更新する
+事前に前述のリリースアーカイブを作成することを推奨するが、必須ではない。
 
-    GitHub に PR を出す場合は、以下のコマンドを実行して Vim のソースディレクト
-    リを更新する。
-    (`VIM_SRC_DIR` で Vim のソースディレクトリを指定)
+1.  Vim のソースディレクトリを更新する
+
+    GitHub に PR を出す場合は、以下のコマンドを実行して lang-ja のファイルを
+    Vim のソースディレクトリへコピーし更新する。
+    `VIM_SRC_DIR` で Vim のソースディレクトリの位置を指定する。
 
         $ make update-src-dir VIM_SRC_DIR=../vim
 
@@ -265,35 +294,23 @@ nsis/lang                          |Windows用インストーラーの翻訳フ
               +-- ja.sjis.po
     ```
 
-6.  タグを打ち、GitHub Releases を更新する
-
-    タグの形式は YYYYMMDD とする。例:
-
-        $ git tag 20181116 -m 'Catch up with 8.1.0519'
-        $ git push origin master --tags
-
-    タグが push できたら、GitHub Releases に新しいリリースを作り、アーカイブ
-    をアップロードする。
-
-7.  Bram に対してリリースする
+2.  vim/vim に対してリリースする
 
     [GitHub][#github] に PR を出す。
+    このとき Sign-off (`git commit -s`) を忘れずに。
+    PR のテンプレートは以下の通りだが、必要に応じて適宜アレンジして良い。
 
-    あるいはこのアーカイブファイルを Bram と vim-dev へ更新依頼とともに送信す
-    る。
-    以下、文面の一例:
-
-        Hi Bram and the list,
-
-        I'd like to update Japanese translations.
-        Could you merge the contents from the attached file into Vim?
-
-        The same file is also available at the vim-jp/lang-ja repository:
-        https://github.com/vim-jp/lang-ja/releases/tag/20181116
+    ```
+    I'd like to updated Japanese translations for the Vim.  The content
+    contained in this PR was created collaboratively by multiple peoples in
+    the vim-jp/lang-ja project, and I, {あなたのなまえ}, am submitting it as
+    the project representative.
 
-        Thanks,
-        (ここにあなたの名前。`Takata`とか)
+    The same file is also available at the vim-jp/lang-ja repository:
+    https://github.com/vim-jp/lang-ja/releases/tag/{最新のタグ}
+    ```
 
+    サンプル: [Vim 9.2リリースに伴う翻訳の更新PR](https://github.com/vim/vim/pull/19215)
 
-[#ci]:https://github.com/vim-jp/lang-ja/actions
+[#ci]:https://github.com/vim-jp/lang-ja/actions/workflows/test.yml
 [#github]:https://github.com/vim/vim