マニュアル: GitHub

投稿日: 更新日:
Git

検索

  • ファイル名: filename:xxx

リリース

GitHubのリリースには2種類あります。 プレリリースは本番環境として利用することを想定していない時に使います。

  • release: 通常のリリース
  • pre-release: プレリリース

また、ドラフトかどうかを選べるが、ドラフトは単に作成中のため非公開にするもの。

なので、 -snapshot リリースを表すには、 pre-release を使うのでいいかと。

ブランチの保護

まずはmasterブランチをforce push不可能にします。 各リポジトリに設定する必要があります。

  1. リポジトリのSettings → Branchesを選択
  2. Add rule を押す
  3. Branch name pattern に master を入力
  4. デフォルトで Protect matching branches が設定されている(変更不可)のため、そのまま Create を押す。

Issueなどの記法

いろいろありますが、<details><summary>...</summary>...</details>が便利そう。

Pull Requestの手順

  1. 対象リポジトリをforkする。
  2. git cloneでforkしたリポジトリをクローン
  3. ローカルでブランチを作成。git checkout -b ブランチ名
  4. 修正をコミット
  5. 自分のリポジトリにpush。git push -u origin ブランチ名
  6. GitHubでPull Requestを作成する。

プログラムでのreleaseへのアップロード

以下のプログラム(Go製)を使う。

CircleCIの場合

CircleCIの場合は以下のようにする。

以下の2つの環境変数を設定する必要あり。

  • GITHUB_TOKEN: アクセストークン
    • プライベートリポジトリ: スコープには repo が必要
    • パブリックリポジトリ: スコープには public_repo が必要(?)
  • VERSION: バージョン
    • 例には $(my-binary --version) と書いているように、ソースコードかバイナリから取得する(できるようにする)。

API

v3がREST API、v4がGraphQL APIになってます。

公式サイト

外部サイト

逆引きマニュアル