Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

リポジトリ間で共有するファイルを配置する #1

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/10-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: 不具合の報告 (.github リポジトリ)
description: 不具合を報告するためのテンプレートです。セキュリティ関連の問題、脆弱性の報告は、セキュリティアドバイザリを通じて提出してください。
title: "[Bug]: "
labels: ["不具合", "not triaged"]
body:
- type: markdown
attributes:
value: |
不具合の報告にご協力いただきありがとうございます!
報告したい不具合が機密情報を含むセキュリティ関連の問題、脆弱性である場合、 [Open a draft security advisory](../security/advisories/new) から報告するようお願いします。
- type: textarea
id: expected-behavior
attributes:
label: 期待する動作
description: 本来あるべき状態や動作を詳細に説明してください。
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: 現在の動作
description: 現在の状態や動作を説明してください。
validations:
required: true
- type: textarea
id: possible-solution
attributes:
label: 考えられる解決策
description: どのようにすれば不具合を解決できるか、案を記載してください。不明な場合は未記載で構いません。
- type: textarea
id: repro-steps
attributes:
label: 再現手順
description: 不具合の再現手順や入力値を記載してください。再現手順が不明な場合は未記載で構いません。
value: |
1.
2.
3.
- type: textarea
id: environment
attributes:
label: 環境
description: 不具合の発生する環境やバージョンについて、詳細に記述してください。
value: |
- OS / バージョン : Windows xx / Linux (distribution) / macOS xx
- ブラウザー / バージョン : Chrome xx.xx / Edge xx.xx / FireFox xx.xx / Safari xx.xx
- .NET バージョン : .NET 8.0
- その他 : ビルド環境などできる限り詳細な情報
- type: textarea
id: logs
attributes:
label: ログ・スタックトレース
description: スタックトレースなど、アプリケーションやビルドシステムの出力するログを添付してください。
- type: checkboxes
id: confirmation
attributes:
label: 確認
description: 以下の項目の確認および同意ができたら、チェックボックスをオンにしてください。
options:
- label: 報告しようとしている不具合がセキュリティ関連の問題、脆弱性に関するものではないことを確認しました。セキュリティ関連の問題、脆弱性の場合は [Open a draft security advisory](../security/advisories/new) から報告してください。
required: true
- label: 報告しようとしている不具合が [Issues](../issues) および [Discussions](../discussions) に登録されていないことを確認しました。
required: true
- label: 私たちの [行動規範](../?tab=coc-ov-file) に従うことを同意します。
required: true
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/20-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: 機能要求
description: 新しい機能やドキュメントの追加を要求するためのテンプレートです。
title: "[New feature]: "
labels: ["not triaged"]
body:
- type: markdown
attributes:
value: |
新しい機能・ドキュメントの要望をいただきありがとうございます!
類似の機能およびドキュメントが、 Issue / プルリクエスト / Discussions に登録されていないことを確認してください。
- [Issues](../issues)
- [プルリクエスト](../pulls)
- [Discussions](../discussions)
- type: textarea
id: current-behavior
attributes:
label: 現在の機能やドキュメントに関する問題点
description: 現在提供している機能やドキュメントの問題点や不足について説明してください。必要に応じてスクリーンショットや GIF アニメを含めてください。
placeholder: ex. 私は 〇〇 をしようとしています。しかし、 xx です。
validations:
required: true
- type: textarea
id: possible-solution
attributes:
label: 必要な解決策
description: 問題点を解決するために、あなたが必要としている機能やドキュメントの概要を説明してください。具体的な解決策を検討されている場合は、その内容もあわせて記載ください。
validations:
required: true
- type: textarea
id: good-and-bad-influences
attributes:
label: 良い影響と悪い影響
description: 新しい機能・ドキュメントの追加によって発生することが予想される良い影響、悪い影響があれば記述してください。
- type: textarea
id: scope-of-impact
attributes:
label: 影響範囲
description: 機能やドキュメントの追加および修正によって、どのような人がどの程度その恩恵を受けるか説明してください。
- type: checkboxes
id: confirmation
attributes:
label: 確認
description: 以下の項目の確認および同意ができたら、チェックボックスをオンにしてください。
options:
- label: 要求しようとしている機能およびドキュメントが、既に [Issues](../issues) や [プルリクエスト](../pulls) 、 [Discussions](../discussions) に登録されていないことを確認しました。
required: true
- label: 私たちの [行動規範](../?tab=coc-ov-file) に従うことを同意します。
required: true
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/80-general-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: (汎用)機能および課題の提案
about: 汎用的な機能および課題を提案するテンプレートです。
title: ''
description: ''
labels: not triaged
assignees: ''
---

## 概要

ここに問題点やバグなど、現在の状態ややるべきことの簡単な説明を記述します。

## 詳細 / 機能詳細(オプション)

ここに作成するドキュメントやサンプル、ライブラリの機能詳細を必要に応じて記述します。
「概要」で説明が尽くされている場合、この節を記述する必要はありません。

## 完了条件

ここにこの Issue の完了条件を箇条書きで記載します。
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/99-openapi-generator-update-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Open APIジェネレーターのアップデート
about: openapi-generatorのアップデートを促すIssueのテンプレートです。
title: "[{{ env.TARGET_APP_NAME }}]openapi-generatorをアップデートする from {{ env.CURRENT_VERSION }} to {{ env.LATEST_VERSION }}"
description: ''
labels: ''
assignees: ''
---

## 概要

[openapi-generator](https://github.com/OpenAPITools/openapi-generator) のバージョンアップを検知しました。内容を確認のうえ、下記の通り対応してください。

- openapitools.json のバージョン :{{ env.CURRENT_VERSION }}
- ライブラリのバージョン :{{ env.LATEST_VERSION }}

## 詳細

下記のコマンドを実行し、最新バージョンを選択します。
openapitools.json の version が選択したバージョンに更新されます。

```terminal
npx openapi-generator-cli version-manager list
```

クライアントコードを再生成します。

```terminal
npm run generate-client
```

自動生成されたクライアントコードに差分がある場合、
差分の内容の確認とアプリケーションの動作確認を行ってください。

## 完了条件

- [ ] openapitools.json の version が最新バージョンに更新されていること
- [ ] 生成されたクライアントコードに差分がないか、差分に問題がないこと
- [ ] アプリケーションの動作に問題がないこと
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## この Pull request で実施したこと (.github リポジトリ)

この Pull request で何をしたのか記載します。

## この Pull request では実施していないこと

この Pull request と関連する機能やドキュメントに対して行わなかったことを記載します。
ない場合は「なし」で構いません。
既に Issues 等が作成されている場合は、リンクを記載します。

## Issues や Discussions 、関連する Web サイトなどへのリンク

関連する Issues や Discussion へのリンクを記載します。
また、このプルリクエストを作成するにあたり参照した資料へのリンクを記載します。
22 changes: 22 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/.github/workflows"
schedule:
interval: "daily"
commit-message:
prefix: "github-actions"
labels:
- "CI/CD"
- "dependencies"

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 20
commit-message:
prefix: "npm"
labels:
- "npm"
- "dependencies"
88 changes: 88 additions & 0 deletions .github/workflows/lint-documents.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
name: ドキュメントのリント

on:
pull_request:
branches: [main]
workflow_dispatch:

jobs:
build:
name: ドキュメントのリント
runs-on: ubuntu-latest
steps:
- name: ブランチのチェックアウト
uses: actions/checkout@v4
with:
fetch-depth: 1

- name: Node.js のセットアップ
uses: actions/setup-node@v4
with:
node-version: 21

- name: npm パッケージのインストール
shell: bash
run: npm ci

- name: Linter の処理開始
shell: bash
run: echo '# Linter Result :newspaper:' >> $GITHUB_STEP_SUMMARY

- name: cSpell の実行
id: run-cspell
continue-on-error: true
shell: bash
run: |
echo '## cSpell Result' >> $GITHUB_STEP_SUMMARY
npm run lint:cspell-all > cspell-result.txt 2>&1
echo ':heavy_check_mark: cSpell に成功しました。' >> $GITHUB_STEP_SUMMARY

- name: cSpell 失敗時の結果表示
shell: bash
if: ${{ steps.run-cspell.outcome == 'failure' }}
run: |
echo ':x: cSpell に失敗しました。 ' >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
cat cspell-result.txt >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
echo 'LINT_STATUS=Error' >> $GITHUB_ENV

- name: Markdownlint の実行
id: run-markdownlint
continue-on-error: true
shell: bash
run: |
echo '## Markdownlint Result' >> $GITHUB_STEP_SUMMARY
npm run lint:markdownlint-all > markdownlint-result.txt 2>&1
echo ':heavy_check_mark: Markdownlint に成功しました。' >> $GITHUB_STEP_SUMMARY

- name: Markdownlint 失敗時の結果表示
shell: bash
if: ${{ steps.run-markdownlint.outcome == 'failure' }}
run: |
echo ':x: Markdownlint に失敗しました。 ' >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
cat markdownlint-result.txt >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
echo 'LINT_STATUS=Error' >> $GITHUB_ENV

- name: textlint の実行
shell: bash
run: |
echo '## textlint Result' >> $GITHUB_STEP_SUMMARY
npm run lint:textlint-all -- --output-file textlint-result.txt --format compact
if [ -f textlint-result.txt ]; then
echo ':x: textlint に失敗しました。 ' >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
cat textlint-result.txt >> $GITHUB_STEP_SUMMARY
echo '```' >> $GITHUB_STEP_SUMMARY
echo 'LINT_STATUS=Error' >> $GITHUB_ENV
else
echo ':heavy_check_mark: textlint に成功しました。' >> $GITHUB_STEP_SUMMARY
fi

- name: Lint 結果の確認
shell: bash
if: ${{ env.LINT_STATUS == 'Error' }}
run: exit 1
13 changes: 13 additions & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
gitignore: true

# 全ての md ファイルを対象に markdownlint-cli2 を実行する
# ただし、 Github の Issues や Pull requests に使用されるテンプレート用の md はテスト対象から除外する
# Github の Issues や Pull requests に設定の Tag が含まれることを防ぐため yaml 上で除外設定を実行する
globs:
- "**/*.md"
- "!**/.github/ISSUE_TEMPLATE/**/*.md"
- "!**/.github/pull_request_template.md"

# md ファイル以外の markdownlint の除外対象を以下に記載する
ignores:
- "LICENSE"
19 changes: 19 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
default: true
line-length: false

ol-prefix:
style: "one"
ul-style:
style: "dash"

ol-indent:
indent: 4
ul-indent:
indent: 4

MD025:
front_matter_title: ""

MD046: false
MD051: false
3 changes: 3 additions & 0 deletions .textlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Github の Issues や Pull requests のテンプレートファイルをテスト対象から除外
.github/pull_request_template.md
.github/ISSUE_TEMPLATE/*.md
Loading