Merge pull request #6 from oqtopus-team/develop

Release 2024-09-04 14:46
oqtopus-team · Sep 4, 2024 · 355338f · 355338f
2 parents 6bf7b5d + b214db0
commit 355338f
Show file tree

Hide file tree

Showing 13 changed files with 109 additions and 27 deletions.
diff --git a/.github/git-pr-release.erb b/.github/git-pr-release.erb
@@ -0,0 +1,6 @@
+Release <%= Time.now.strftime('%Y-%m-%d %H:%M') %>
+> [!CAUTION]
+> **Create Merge Commit** is recommended to merge this PR.
+<% pull_requests.each do |pr| -%>
+- #<%= pr.number %> <%= pr.mention %>
+<% end -%>
diff --git a/.github/release.yaml b/.github/release.yaml
@@ -0,0 +1,11 @@
+changelog:
+  categories:
+    - title: Enhancement 🎉
+      labels:
+        - enhancement
+    - title: Bug Fixes 🐛
+      labels:
+        - bug
+    - title: Documentation 📚
+      labels:
+        - documentation
diff --git a/.github/workflows/git-pr-release.yaml b/.github/workflows/git-pr-release.yaml
@@ -0,0 +1,24 @@
+name: git-pr-release
+on:
+  push:
+    branches:
+    - develop
+jobs:
+  git-pr-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # git-pr-release needs the git histories
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+      - run: gem install --no-document git-pr-release
+      - run: git-pr-release --squashed
+        env:
+          GIT_PR_RELEASE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GIT_PR_RELEASE_BRANCH_PRODUCTION: main
+          GIT_PR_RELEASE_BRANCH_STAGING: develop
+          GIT_PR_RELEASE_LABELS: release
+          GIT_PR_RELEASE_TEMPLATE: .github/git-pr-release.erb
+          TZ: Asia/Tokyo
diff --git a/.github/workflows/python-ci.yml → .github/workflows/python-ci.yaml b/.github/workflows/python-ci.yml → .github/workflows/python-ci.yaml
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -0,0 +1,18 @@
+name: Release
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      VERSION: ${{ github.ref_name }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - run: |
+          gh release create "${VERSION}" --title "${VERSION}" --generate-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/tflint.yml → .github/workflows/tflint.yaml b/.github/workflows/tflint.yml → .github/workflows/tflint.yaml
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,6 +1,6 @@
 cff-version: 1.2.0
 message: "If you use this software, please cite it as below."
-title: "OQTOPUS-CLOUD"
+title: "OQTOPUS Cloud"
 authors:
 - family-names: "Aso"
   given-names: "Noriyasu"
@@ -14,15 +14,16 @@ authors:
   given-names: "Toshio"
 - family-names: "Miyanaga"
   given-names: "Takafumi"
+  orcid: "https://orcid.org/0009-0001-5094-6035"
 - family-names: "Noda"
   given-names: "Kunihiro"
 - family-names: "Tsukano"
   given-names: "Satoyuki"
   orcid: "https://orcid.org/0009-0000-3825-9083"
 - family-names: "Ymaguchi"
   given-names: "Masaomi"
-version: 1.0.0
-date-released: 2024-09-01
+version: 0.1.0
+date-released: 2024-09-04
 license: Apache-2.0
 repository-code: "https://github.com/oqtopus-team/oqtopus-cloud"
 url: "https://github.com/oqtopus-team.github.io/oqtopus-cloud"
diff --git a/docs/README.ja.md b/docs/README.ja.md
@@ -11,7 +11,7 @@
   </thead>
 </table>
 
-[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml)[![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml)[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml) [![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 </div>
 
@@ -69,19 +69,19 @@ OQTOPUS Cloudを研究で使用する場合は、以下のGitHubリポジトリ
 ### APA
 
 ```apacite
-Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS-CLOUD (Version 1.0.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
+Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS Cloud (Version 0.1.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
 ```
 
 ### BibTeX
 
 ```bibtex
-@software{Aso_OQTOPUS-CLOUD_2024,
+@software{Aso_OQTOPUS_Cloud_2024,
 author = {Aso, Noriyasu and Gokita, Shun and Kakuko, Norihiro and Masumoto, Naoyuki and Mori, Toshio and Miyanaga, Takafumi and Noda, Kunihiro and Tsukano, Satoyuki and Ymaguchi, Masaomi},
 license = {Apache-2.0},
 month = sep,
-title = {{OQTOPUS-CLOUD}},
+title = {{OQTOPUS Cloud}},
 url = {https://github.com/oqtopus-team/oqtopus-cloud},
-version = {1.0.0},
+version = {0.1.0},
 year = {2024}
 }
 ```

diff --git a/docs/README.md b/docs/README.md
@@ -11,7 +11,7 @@
   </thead>
 </table>
 
-[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml)[![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml)[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml) [![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 </div>
 
@@ -69,19 +69,19 @@ If you use OQTOPUS Cloud in your research, please cite the following GitHub repo
 ### APA
 
 ```apacite
-Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS-CLOUD (Version 1.0.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
+Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS Cloud (Version 0.1.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
 ```
 
 ### BibTeX
 
 ```bibtex
-@software{Aso_OQTOPUS-CLOUD_2024,
+@software{Aso_OQTOPUS_Cloud_2024,
 author = {Aso, Noriyasu and Gokita, Shun and Kakuko, Norihiro and Masumoto, Naoyuki and Mori, Toshio and Miyanaga, Takafumi and Noda, Kunihiro and Tsukano, Satoyuki and Ymaguchi, Masaomi},
 license = {Apache-2.0},
 month = sep,
-title = {{OQTOPUS-CLOUD}},
+title = {{OQTOPUS Cloud}},
 url = {https://github.com/oqtopus-team/oqtopus-cloud},
-version = {1.0.0},
+version = {0.1.0},
 year = {2024}
 }
 ```

diff --git a/docs/en/index.md b/docs/en/index.md
@@ -11,13 +11,13 @@
   </thead>
 </table>
 
-[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml)[![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml)[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml) [![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 </div>
 
 ## Overview
 
-OQTOPUS Cloud is a project that provides the architecture of cloud quantum computers as an open-source software (OSS).
+**O**pen **Q**uantum **T**oolchain for **OP**erators & **US**ers (**OQTOPUS**) is a project that provides the architecture of cloud quantum computers as an open-source software (OSS).
 By using it in conjunction with various OSS provided by [@oqtopus-team](https://github.com/oqtopus-team), you can build a cloud quantum computer system.
 
 ![OQTOPUS Cloud](./asset/aws_system_architecture_diagram_overview.drawio.png)
@@ -64,24 +64,24 @@ By using it in conjunction with various OSS provided by [@oqtopus-team](https://
 
 ## CITATION
 
-If you use OQTOPUS Cloud in your research, please cite the following paper:
+If you use OQTOPUS Cloud in your research, please cite the following GitHub repository:
 
 ### APA
 
 ```apacite
-Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS-CLOUD (Version 1.0.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
+Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS Cloud (Version 0.1.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
 ```
 
 ### BibTeX
 
 ```bibtex
-@software{Aso_OQTOPUS-CLOUD_2024,
+@software{Aso_OQTOPUS_Cloud_2024,
 author = {Aso, Noriyasu and Gokita, Shun and Kakuko, Norihiro and Masumoto, Naoyuki and Mori, Toshio and Miyanaga, Takafumi and Noda, Kunihiro and Tsukano, Satoyuki and Ymaguchi, Masaomi},
 license = {Apache-2.0},
 month = sep,
-title = {{OQTOPUS-CLOUD}},
+title = {{OQTOPUS Cloud}},
 url = {https://github.com/oqtopus-team/oqtopus-cloud},
-version = {1.0.0},
+version = {0.1.0},
 year = {2024}
 }
 ```

diff --git a/docs/en/operation/deployment.md b/docs/en/operation/deployment.md
@@ -169,6 +169,17 @@ make test-user
 make test-provider
 ```
 
+## Release
+
+We are adopting [Semantic Versioning](https://semver.org/).
+
+The creation of release notes is automated, so you can tag and create release notes by executing the following commands:
+
+```bash
+git tag v1.0.0
+git push origin v1.0.0
+```
+
 ## List of Commands
 
 ```bash

diff --git a/docs/ja/index.md b/docs/ja/index.md
@@ -11,13 +11,13 @@
   </thead>
 </table>
 
-[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml)[![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml)[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python CI](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/python-ci.yml) [![TFLint](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml/badge.svg)](https://github.com/oqtopus-team/oqtopus-cloud/actions/workflows/tflint.yml) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 </div>
 
 ## 概要
 
-OQTOPUS Cloud は クラウド量子コンピュータのアーキテクチャをOSSとして提供するプロジェクトです。
+**O**pen **Q**uantum **T**oolchain for **OP**erators & **US**ers (**OQTOPUS**) は クラウド量子コンピュータのアーキテクチャをOSSとして提供するプロジェクトです。
 [@oqtopus-team](https://github.com/oqtopus-team)が提供している各種OSSと連携して利用することで、クラウド量子コンピュータシステムを構築することができます。
 
 ![OQTOPUS Cloud](./asset/aws_system_architecture_diagram_overview.drawio.png)
@@ -64,24 +64,24 @@ OQTOPUS Cloud は クラウド量子コンピュータのアーキテクチャ
 
 ## 引用
 
-OQTOPUS Cloudを研究で使用する場合は、以下の論文を引用してください。
+OQTOPUS Cloudを研究で使用する場合は、以下のGitHubリポジトリを引用してください。
 
 ### APA
 
 ```apacite
-Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS-CLOUD (Version 1.0.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
+Aso, N., Gokita, S., Kakuko, N., Masumoto, N., Mori, T., Miyanaga, T., Noda, K., Tsukano, S., & Ymaguchi, M. (2024). OQTOPUS Cloud (Version 0.1.0) [Computer software]. https://github.com/oqtopus-team/oqtopus-cloud
 ```
 
 ### BibTeX
 
 ```bibtex
-@software{Aso_OQTOPUS-CLOUD_2024,
+@software{Aso_OQTOPUS_Cloud_2024,
 author = {Aso, Noriyasu and Gokita, Shun and Kakuko, Norihiro and Masumoto, Naoyuki and Mori, Toshio and Miyanaga, Takafumi and Noda, Kunihiro and Tsukano, Satoyuki and Ymaguchi, Masaomi},
 license = {Apache-2.0},
 month = sep,
-title = {{OQTOPUS-CLOUD}},
+title = {{OQTOPUS Cloud}},
 url = {https://github.com/oqtopus-team/oqtopus-cloud},
-version = {1.0.0},
+version = {0.1.0},
 year = {2024}
 }
 ```

diff --git a/docs/ja/operation/deployment.md b/docs/ja/operation/deployment.md
@@ -172,6 +172,17 @@ make test-user
 make test-provider
 ```
 
+## リリース
+
+バージョニングは[セマンティックバージョニング](https://semver.org/)を採用しています。
+
+リリースノートの作成は自動化しているため、以下のコマンドを実行することでタグ打ちとリリースノートの作成が行われます。
+
+```bash
+git tag v1.0.0
+git push origin v1.0.0
+```
+
 ## コマンド一覧
 
 ```bash