forGitBranch release setup (#151)

future-architect · Jul 23, 2024 · 551bcac · 551bcac
1 parent e0ca7d8
commit 551bcac
Show file tree

Hide file tree

Showing 11 changed files with 420 additions and 342 deletions.
diff --git a/.vuepress/config.js b/.vuepress/config.js
@@ -29,6 +29,10 @@ const links = {
     "/documents/forOpenAPISpecification/OpenAPI_Specification_2.0.html",
     "/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.html",
   ],
+  "/documents/forGitBranch/": [
+    "/documents/forGitBranch/",
+    "/documents/forGitBranch/Gitブランチフロー規約.html",
+  ],
 };
 console.log(links);
 
@@ -133,6 +137,20 @@ module.exports = {
               },
             ],
           },
+          {
+            text: "Gitブランチフロー規約",
+            items: [
+              {
+                text: "Home",
+                link: "/documents/forGitBranch/",
+              },
+              {
+                text: "Gitブランチフロー規約",
+                link: "/documents/forGitBranch/Gitブランチフロー規約.html",
+              },
+
+            ],
+          },
         ],
       },
       {

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ features:
     details: エンタープライズ領域では、社員・パートナーの方々を合わせて、数百人が同時に開発することも珍しくありません。 ちょっとした悩み、失敗も、人数が集まれば大変なコスト・リスクになります。 誰もが引っかかる落とし穴、悩みの種をあらかじめ排除します。
   - title: Performance
     details: 時に読みやすいソースコードはパフォーマンス劣化を招くことがあります。 しかし、常にパフォーマンスを優先したソースコードは人間の読めないソースコードになりがちです。 今、書こうとしているソースコードが、どの程度のパフォーマンスになるのか、指標を示すことで、ソフトウェア開発プロジェクトごとに最適なソースコードを選択することができます。
-footer: ©2015 - 2023 Future Enterprise Coding Standards - Future Corporation
+footer: ©2015 - 2024 Future Enterprise Coding Standards - Future Corporation
 ---
 
 [![GitHub last commit](https://img.shields.io/github/last-commit/future-architect/coding-standards.svg)](https://github.com/future-architect/coding-standards)

diff --git a/documents/forGitBranch/Gitブランチフロー規約.md b/documents/forGitBranch/Gitブランチフロー規約.md
diff --git a/documents/forGitBranch/README.md b/documents/forGitBranch/README.md
diff --git a/documents/forGitBranch/commit_message_rule.md b/documents/forGitBranch/commit_message_rule.md
@@ -1,4 +1,10 @@
-# コミットメッセージ規約
+---
+sidebarDepth: 4
+title: Gitブランチフロー規約 - コミットメッセージ規約
+author: フューチャー株式会社
+---
+
+## コミットメッセージ規約
 
 Gitのコミットメッセージにの書式についてルール化することで、コミットの目的がわかりやすくなる、履歴からのトラッキングの容易になる利点がある。
 

diff --git a/documents/forGitBranch/each_branch.md b/documents/forGitBranch/each_branch.md
@@ -1,4 +1,10 @@
-# ブランチの整理
+---
+sidebarDepth: 4
+title: Gitブランチフロー規約 - ブランチの整理
+author: フューチャー株式会社
+---
+
+## ブランチの整理
 
 本ドキュメントで想定する、各ブランチの特徴を説明する。
 

diff --git a/documents/forGitBranch/merge_develop_to_feature.md b/documents/forGitBranch/merge_develop_to_feature.md
@@ -1,4 +1,10 @@
-# 開発ブランチに機能ブランチの変更を取り込む方法
+---
+sidebarDepth: 4
+title: Gitブランチフロー規約 - 開発ブランチに機能ブランチの変更を取り込む方法
+author: フューチャー株式会社
+---
+
+## 開発ブランチに機能ブランチの変更を取り込む方法
 
 機能ブランチに対して開発ブランチの変更を取り込む方法は「マージ」と「リベース」2つの方法が考えられる。
 

diff --git a/documents/forGitBranch/merge_feature_to_develop.md b/documents/forGitBranch/merge_feature_to_develop.md
@@ -1,4 +1,10 @@
-# 開発ブランチに機能ブランチの変更を取り込む方法
+---
+sidebarDepth: 4
+title: Gitブランチフロー規約 - 開発ブランチに機能ブランチの変更を取り込む方法
+author: フューチャー株式会社
+---
+
+## 開発ブランチに機能ブランチの変更を取り込む方法
 
 プルリクエストを経由して、開発が完了した機能ブランチをメインの開発ブランチに取り込むためには、GitHub（GitLab）上でプルリクエスト（マージリクエスト）を経由する運用を前提とする。
 

diff --git a/documents/forGitBranch/recommended_settings.md b/documents/forGitBranch/recommended_settings.md
@@ -1,4 +1,10 @@
-# 推奨設定
+---
+sidebarDepth: 4
+title: Gitブランチフロー規約 - 推奨設定
+author: フューチャー株式会社
+---
+
+## 推奨設定
 
 GitやGitHubの推奨設定をまとめる。本ドキュメントにあるGitブランチ運用はこの設定が行われている前提で説明する箇所がある。
 

diff --git a/documents/forGitBranch/vscode_git_ope.md b/documents/forGitBranch/vscode_git_ope.md
@@ -1,4 +1,10 @@
-# VSCode上でのGit操作
+---
+sidebarDepth: 4
+title: Gitブランチフロー規約 - VSCode上でのGit操作
+author: フューチャー株式会社
+---
+
+## VSCode上でのGit操作
 
 利用頻度が高いとされるVS CodeでのGit操作を紹介する。
 

diff --git a/package.json b/package.json
@@ -17,7 +17,9 @@
     "pandoc:awsresource-html": "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md -s --self-contained --number-sections --toc -t html5 -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forAWSResource/AWSインフラリソース命名規約.html",
     "pandoc:awsresource-word": "pandoc ./documents/forAWSResource/AWSインフラリソース命名規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -s -o ./documents/forAWSResource/AWSインフラリソース命名規約.docx",
     "pandoc:swagger-html": "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md -s --self-contained --number-sections --toc -t html5 -F mermaid-filter.cmd -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0規約.html",
-    "pandoc:swagger-word": "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -F mermaid-filter.cmd -s -o ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0規約.docx"
+    "pandoc:swagger-word": "pandoc ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -F mermaid-filter.cmd -s -o ./documents/forOpenAPISpecification/OpenAPI_Specification_2.0規約.docx",
+    "pandoc:gitbranch-html": "pandoc ./documents/forGitBranch/Gitブランチフロー規約.md -s --self-contained --number-sections --toc -t html5 -F mermaid-filter.cmd -c ./documents/common/pandoc_styles/css/style.css -o ./documents/forGitBranch/Gitブランチフロー規約.html",
+    "pandoc:gitbranch-word": "pandoc ./documents/forGitBranch/Gitブランチフロー規約.md --toc --reference-doc=./documents/common/pandoc_styles/スタイル.docx -F mermaid-filter.cmd -s -o ./documents/forGitBranch/Gitブランチフロー.docx"
   },
   "repository": {
     "type": "git  ",