Appearance
GitHub リポジトリをアーカイブする
このドキュメントでは、GitHub 上のリポジトリをアーカイブする目的、手順、命名規則、注意点について説明します。
TIP
リポジトリをアーカイブする際の 命名規則 は以下の通りです。
命名規則:arch_XXX
アーカイブ対象のリポジトリ名の先頭に arch_ を付与し、
元のリポジトリがアーカイブされていることを明確に示してください。
例:
arch_project-aarch_sample-apiarch_legacy-tool
1. はじめに
アーカイブとは、リポジトリを 読み取り専用 (read-only) にし、今後そのプロジェクトを更新しないことを示すための機能です。
保守終了・統合済み・非推奨になったプロジェクトに利用されます。
2. アーカイブ前のチェックリスト
アーカイブ前に、次のポイントを確認してください:
✔ 管理者権限があるか
アーカイブ操作には Admin 権限 が必要です。
✔ 今後更新しないと判断できているか
プロジェクトの開発・保守を継続しないことが明確になっているか確認します。
✔ README などにアーカイブの理由・移行先の記述を追加したか(任意)
利用者が迷わないようにすると親切です。
✔ リポジトリ名を命名規則に従って変更する
アーカイブ対象リポジトリの名前を以下にリネームしてください:
arch_XXX(命名規則)
例:
arch_frontendarch_docs-system
✔ アーカイブ後に行えなくなる操作を理解しているか
- プッシュ不可
- Issue / Pull Request 作成不可
- GitHub Actions の停止
- リリース作成不可
- プロジェクトボードの変更不可
3. アーカイブ手順(命名規則を含む)
① リポジトリ名をアーカイブ命名規則に変更する
リポジトリトップ → Settings → General → Repository name で
以下の形式にリネームします:
➡ arch_リポジトリ名
例:
arch_my-old-projectarch_2021-tools
② GitHub リポジトリを開く
アーカイブ対象のリポジトリページにアクセスします。
③ 「Settings」タブを開く
リポジトリの上部メニューから Settings を選択。
④ 「Danger Zone」までスクロールする
ページ最下部付近の赤枠エリアです。
⑤ “Archive this repository” を選択
Archive this repository をクリックします。
⑥ 確認としてリポジトリ名を入力し、アーカイブを実行
GitHub の指示通り、リポジトリ名(変更後の arch_XXX 名)を入力し確定します。
アーカイブが完了すると、リポジトリ上部に
「This repository is archived」
という黄色いバナーが表示されます。
4. アーカイブ後の動作
アーカイブされたリポジトリは 完全な read-only 状態になります。
利用可能:
- コードの閲覧
- Issue / PR の過去ログ閲覧
- README / Wiki の閲覧
利用不可:
- コミット、Push
- Issue 作成
- Pull Request 作成
- GitHub Actions 実行
- Release の作成
5. アーカイブの解除(Unarchive)
アーカイブを解除したい場合:
- アーカイブ済みリポジトリの Settings を開く
- 再び Danger Zone に進む
- Unarchive this repository をクリック
- 確認して実行
解除後は通常通り操作が可能になります。