From 63b59815008f76eef3e3bd4acb5e3636723ed0ea Mon Sep 17 00:00:00 2001 From: Takafumi Miyanaga Date: Tue, 3 Sep 2024 12:17:29 +0900 Subject: [PATCH 1/7] Update README.md --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 532e446..e6a7d3d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,7 +11,7 @@ -[![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) From f68e7595372765979f2d453a30b5f55bdb9dc7d0 Mon Sep 17 00:00:00 2001 From: Takafumi Miyanaga Date: Tue, 3 Sep 2024 12:17:49 +0900 Subject: [PATCH 2/7] Update README.ja.md --- docs/README.ja.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.ja.md b/docs/README.ja.md index 6278979..3308d7f 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -11,7 +11,7 @@ -[![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) From 1238e939b19901c71dda3a53fc89c3025f67a587 Mon Sep 17 00:00:00 2001 From: Takafumi Miyanaga Date: Tue, 3 Sep 2024 14:00:18 +0900 Subject: [PATCH 3/7] chore: Update CITATION.cff with corrected title and version (#1) --- CITATION.cff | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 64eb252..89a35de 100644 --- 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" @@ -21,8 +21,8 @@ authors: 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" From 73abd0731c25c43e1135e7e5388e676a6778a7b7 Mon Sep 17 00:00:00 2001 From: orangekame3 Date: Tue, 3 Sep 2024 16:39:17 +0900 Subject: [PATCH 4/7] update citation docs --- docs/README.ja.md | 8 ++++---- docs/README.md | 8 ++++---- docs/en/index.md | 14 +++++++------- docs/ja/index.md | 14 +++++++------- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/README.ja.md b/docs/README.ja.md index 3308d7f..144496e 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -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 index e6a7d3d..857b401 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 index a60ebf2..857b401 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -11,13 +11,13 @@ -[![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) ## 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/ja/index.md b/docs/ja/index.md index 09bf8c3..144496e 100644 --- a/docs/ja/index.md +++ b/docs/ja/index.md @@ -11,13 +11,13 @@ -[![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) ## 概要 -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} } ``` From 5a07e512f77788804f46615a4174d0aa4dd3bc75 Mon Sep 17 00:00:00 2001 From: orangekame3 Date: Tue, 3 Sep 2024 17:02:02 +0900 Subject: [PATCH 5/7] add orcid miyanaga --- CITATION.cff | 1 + 1 file changed, 1 insertion(+) diff --git a/CITATION.cff b/CITATION.cff index 89a35de..6872843 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -14,6 +14,7 @@ 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" From 3b803e4a5d24bedb526dd1113d92754fb99088d7 Mon Sep 17 00:00:00 2001 From: orangekame3 Date: Tue, 3 Sep 2024 19:49:05 +0900 Subject: [PATCH 6/7] add automation release note flow --- .github/release.yaml | 11 +++++++++++ .../{python-ci.yml => python-ci.yaml} | 0 .github/workflows/release.yaml | 18 ++++++++++++++++++ .github/workflows/{tflint.yml => tflint.yaml} | 0 docs/en/operation/deployment.md | 11 +++++++++++ docs/ja/operation/deployment.md | 11 +++++++++++ 6 files changed, 51 insertions(+) create mode 100644 .github/release.yaml rename .github/workflows/{python-ci.yml => python-ci.yaml} (100%) create mode 100644 .github/workflows/release.yaml rename .github/workflows/{tflint.yml => tflint.yaml} (100%) diff --git a/.github/release.yaml b/.github/release.yaml new file mode 100644 index 0000000..99d159f --- /dev/null +++ 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/python-ci.yml b/.github/workflows/python-ci.yaml similarity index 100% rename from .github/workflows/python-ci.yml rename to .github/workflows/python-ci.yaml diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..eeafb1e --- /dev/null +++ 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 b/.github/workflows/tflint.yaml similarity index 100% rename from .github/workflows/tflint.yml rename to .github/workflows/tflint.yaml diff --git a/docs/en/operation/deployment.md b/docs/en/operation/deployment.md index 75163d9..8d91ba4 100644 --- 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/operation/deployment.md b/docs/ja/operation/deployment.md index 3fe58ed..ea715ee 100644 --- 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 From b214db009a79142fe103a0de57ad48c76018c72d Mon Sep 17 00:00:00 2001 From: Takafumi Miyanaga Date: Wed, 4 Sep 2024 14:44:00 +0900 Subject: [PATCH 7/7] add git-pr-release (#5) --- .github/git-pr-release.erb | 6 ++++++ .github/workflows/git-pr-release.yaml | 24 ++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 .github/git-pr-release.erb create mode 100644 .github/workflows/git-pr-release.yaml diff --git a/.github/git-pr-release.erb b/.github/git-pr-release.erb new file mode 100644 index 0000000..cf13185 --- /dev/null +++ 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/workflows/git-pr-release.yaml b/.github/workflows/git-pr-release.yaml new file mode 100644 index 0000000..e3bcb76 --- /dev/null +++ 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