Skip to content
This repository has been archived by the owner on Apr 12, 2023. It is now read-only.

Add scripts to insert the MPL notification #237

Open
wants to merge 17 commits into
base: feature/license_tools
Choose a base branch
from

Conversation

Meiryo7743
Copy link
Contributor

@Meiryo7743 Meiryo7743 commented Jun 13, 2021

Issue 番号 / Issue ID

目的 / Purpose

  • MPL の通知の記載漏れを確認する shell script を追加する。
    • Commit 時に ライセンスの記載漏れがないか確認する(pre-commit の機能を利用)

破壊的変更をもたらしますか / Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request の種類 / Pull Request type

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

検証方法 / How to test

コードの入手 / Get the code

git clone https://github.com/Meiryo7743/cocoa.git
git switch feature/mpl-license-notification-with-git-hooks

コードの検証 / Test the code

※誤 push なさらぬよう十分にお気を付けください

pre-commit の動作確認

  1. 以下を実行する
    # Git Hooks を有効にする
    bash Tools/GitHooks/PrepareHooks.sh
  2. 3 行以上の内容が含まれていて,かつ MPL が記載されていない状態のファイル(*.cs*.xml など)を生成し,commit する

CheckAllFiles.sh の動作確認

  1. 3 行以上の内容が含まれていて,かつ MPL が記載されていない状態のファイル(*.cs*.xml など)を生成する
  2. 以下を実行する
    bash Tools/AddLicense/CheckAllFiles.sh
  3. 手順 1 で生成したファイルに MPL が挿入されていることを確認する

確認事項 / What to check

  • Windows/macOS でも動作するか
    • WSL2 上の Ubuntu 20.04.2 LTS では,意図した通りに動くことを確認しました。
  • MPL 対象のファイルを確かに網羅しているか
    • git grep --name-only -L -I 'This Source Code Form is subject to the terms of the Mozilla Public' の結果をそのまま除外対象とみなしました(cf. Tools/AddLicense/Exclusions.txt)。
  • ドキュメントの追加
    • pre-commit の有効化についての文書化が必要と考えておりますが,どこに記載しましょうか……?
  • GitHub Actions
    • 必要でしたら,GitHub Actions でも実行可能にいたします。

その他 / Other information


Internal IDs:

  • NFR 2704

@Meiryo7743 Meiryo7743 marked this pull request as ready for review June 14, 2021 14:09
@Takym
Copy link
Contributor

Takym commented Jun 22, 2021

#236 とファイル構造を統一するためにディレクトリ名・ファイル名を AddLicenseHeader に変更できませんでしょうか?

@Meiryo7743
Copy link
Contributor Author

#236 とファイル構造を統一するためにディレクトリ名・ファイル名を AddLicenseHeader に変更できませんでしょうか?

本 PR と #236 の merge が確定次第,調整する予定です。

@Meiryo7743
Copy link
Contributor Author

Meiryo7743 commented Jun 22, 2021

@keiji @cocoa-dev

一通り実装が完了しましたので,よろしければ review をお願いいたします。

@Takym
Copy link
Contributor

Takym commented Jun 26, 2021

マージ時に閉じる Issue を #229 から #255 に変更して頂けますと幸いです。

@cocoa-dev cocoa-dev added the confirmed 開発内部管理用 label Jun 28, 2021
@Takym
Copy link
Contributor

Takym commented Jun 29, 2021

#236 とファイル構造を統一するためにディレクトリ名・ファイル名を AddLicenseHeader に変更できませんでしょうか?

#261 作成に伴いディレクトリ「AddLicenseHeader」を「LicenseHeader」に変更しました事を報告致します。

@keiji keiji changed the base branch from develop to feature/license_tools July 6, 2021 07:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
confirmed 開発内部管理用
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ライセンス通知の自動付与ツールを作成する
4 participants