Forgejo は、ソースコードの保管庫 (Git) のアプリです。リポジトリ・イシュー (課題)・プルリクエスト (GitLab のマージリクエスト)・Wiki・リリースを、この箱に置きます。GitLab の代わりに使えます。
はじめに (管理者)
- ログイン: 言箱から Forgejo を開き、サインイン画面の kotohako でサインイン を押します。初めての人は、それだけでアカウントができます。ユーザー名・パスワードの欄は使いません。
- 言箱の管理者・オーナーは Forgejo の管理者になります。
- リポジトリを見るにもサインインが要ります。
- 部署やチームでリポジトリをまとめるなら、右上の + › 新しい組織 で組織を作り、チームと権限を決めます。
- この箱の Forgejo について:
- git は HTTP だけです。SSH は使えません。
- CI (Forgejo Actions) を動かす仕組み (ランナー) は用意していません。GitLab の
.gitlab-ci.yml は読まれません。 - メールは送りません。通知は Forgejo の中の 通知 (ベル) で見ます。言箱の通知には届きません。
- GitLab から移すときは、下の「データ・控え」を見てください。
はじめに (使う人)
- 言箱のアプリセンターから Forgejo を開き、kotohako でサインイン。
- git で使う アクセストークン を作ります。右上の自分のアイコン › 設定 › アプリケーション の アクセストークン で、
- トークン名 を入れ (例: 自分の PC)、
- 許可の選択 で repository を 読み取りと書き込み にして、
- トークンを生成 を押します。トークンは 1 回しか表示されないので、すぐ控えます。
- リポジトリの画面で clone の URL (HTTP) をコピーして clone します。ユーザー名は Forgejo のユーザー名 (右上の自分のアイコンで確かめられます)、パスワードはトークンです。
git clone http://<箱の住所>/apps/forgejo/<持ち主>/<リポジトリ>.git
git config --global credential.helper manager # Windows (毎回入れないために)
git config --global credential.helper osxkeychain # Mac
- 新しいリポジトリは、右上の + › 新しいリポジトリ で作ります。
よく使う操作
| やりたいこと | やり方 |
|---|
| 課題を書く | リポジトリの イシュー › 新しいイシュー。ラベル・担当者・マイルストーンを付けられます |
| 変更をレビューしてもらう | ブランチを push → プルリクエスト › 新しいプルリクエスト → プルリクエストを作成 |
| レビューする | プルリクエストの 変更されたファイル で差分を見て、レビュー から 承認 / 変更要請 / コメント |
| マージする | プルリクエストの下で マージコミットを作成 など方法を選んでマージ |
| ブラウザでファイルを足す | リポジトリの ファイルの追加 › 新規ファイル / ファイルをアップロード |
| 手順書を書く | リポジトリの Wiki › 最初のページを作成 |
| 版を出す | リリース › 新しいリリース |
| 人を入れる | リポジトリの 設定 › 共同作業者 › 共同作業者を追加 (読み取り / 書き込み / 管理者) |
| main を守る | リポジトリの 設定 › ブランチ でブランチの保護を設定 |
困ったとき
- git push で認証に失敗する: パスワードの欄にはトークンを入れます。トークンの許可で repository が「読み取りと書き込み」になっているか確かめてください。
- kotohako でサインインできない: 言箱にログインしているか確かめてください。
- リポジトリが見えない: プライベートのリポジトリです。持ち主に共同作業者への追加を頼んでください。
- ブランチに push できない: ブランチが保護されています。プルリクエストでマージしてください。
- トークンを失くした・漏れた: アクセストークン の一覧で 削除 し、作り直します。
データ・控え
- リポジトリ・イシュー・Wiki はすべてこの箱の中に置きます。
- 持ち出す:
git clone --mirror で全ブランチ・タグを持ち出せます。ファイルだけなら ZIPファイルをダウンロード。 - GitLab から移す (2 つの方法):
- 右上の + › 新しいマイグレーション で GitLab を選び、GitLab の URL とアクセストークンを入れます。イシュー・プルリクエスト (マージリクエスト)・Wiki・リリースも移せます。ただし、この箱の Forgejo は社内ネットワークの中のアドレスからは移せない設定です (gitlab.com などからは移せます)。
- 控え帳で GitLab を控え、控え帳の 置き換え先へ移す で Forgejo へ移します。git の全部とイシューを移します。GitLab が止まっていても移せます。Forgejo のアクセストークン (write:repository・write:organization・write:issue・read:user) が要ります。
- 言箱オリジナルの開発帳でも同じ用途に使えます。
もっと詳しく
- Forgejo の公式ドキュメント (英語): https://forgejo.org/docs/latest/
- 公式サイト: https://forgejo.org/
- このアプリは、オープンソースの Forgejo (Codeberg e.V.、GPL-3.0-or-later) の公式のものを、手を加えずに使っています。版は 15.0.9 です。