ForHosting KIT · 開発者向けツール

Gitコミットハッシュを指定した長さに短縮

このGitコミット短縮ハッシュツールは、完全なSHA-1またはSHA-256オブジェクトIDを受け取り、先頭から指定された数の16進文字を正確に返します。完全な識別子がリリースラベル、ビルド画面、ログの要約、デプロイメモには長すぎる場合に便利です。処理は常に同じ結果になり、入力された英字の大文字と小文字を維持します。完全なハッシュより長い文字数を指定すると、入力エラーとして明確に拒否します。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

予測可能な短いコミット識別子を作成します

GitのオブジェクトIDは正確ですが、完全な16進表記はコンパクトな画面や人が読む記録には長すぎることがあります。この機能は、40文字の完全なSHA-1コミットハッシュ、または64文字の完全なSHA-256コミットハッシュを受け取り、指定された数だけ先頭の文字を返します。これはGitが省略されたオブジェクト名を表示するときの一般的な形式です。長さを明示的に指定するため、リポジトリの規模、ローカル設定、コマンドを実行する端末によって結果が変わりません。たとえば、リリース処理では常に12文字を使用し、幅の狭いステータス表示では8文字を使用できます。結果には短縮値と適用した長さが含まれるため、別のシステムへ渡す前に確認しやすくなっています。入力の大文字と小文字はそのまま維持されます。リポジトリのチェックアウトは不要で、文字列の検証と先頭部分の抽出だけを行います。

衝突の可能性を考えて長さを選びます

短いハッシュは省略表記であり、新しいコミット識別子ではありません。短い接頭辞ほど読みやすくなりますが、リポジトリが大きくなると複数のオブジェクトに一致する可能性も高くなります。Gitは参照できるオブジェクトを調べ、最短の一意な省略形を計算できます。一方、このツールが受け取るのは1個のハッシュだけで、リポジトリを調査しないため、一意性を保証できません。用途と想定するオブジェクト数に合った長さを選択してください。小規模なプロジェクトでは7文字や8文字が便利ですが、大規模な履歴や長期保存するビルド記録には12文字以上のほうが余裕があります。後続のコマンドがリポジトリ内で値を解決する場合は、その接頭辞が曖昧でないことを対象リポジトリで確認してください。この機能は、完全なハッシュより多い文字数を要求する誤りを防ぎます。また、すでに省略された値ではなく、完全なSHA-1またはSHA-256オブジェクトIDを必須とします。

自動処理全体で同じ省略形式を使います

複数のツールで同じリビジョンへ一貫したラベルを付ける場合、固定長の短縮が役立ちます。継続的インテグレーションのジョブでは、プロバイダーが渡す完全なSHAを受け取り、プロジェクトで決めた長さにして、成果物名、コンテナタグ、デプロイ注記、テスト報告などで再利用できます。リリーススクリプトでは、環境固有のGitコマンドを組み込まずに、セマンティックバージョンの横へ短い値を記載できます。監視やサポートのシステムでは、画面に短いリビジョンを示しながら、メタデータには完全なハッシュを保持できます。アルゴリズムは検証と接頭辞の切り出しだけなので、同じ入力からはブラウザーでもAPIでも必ず同じ出力が得られます。ネットワーク、リポジトリ参照、乱数、時刻には依存しません。複数のリポジトリやフォークをまたいで厳密な識別が必要な場合は、正式な参照として完全なIDも保存してください。

活用例

ビルド成果物に識別子を付ける

CIが提供する完全なSHAから、パッケージやアーカイブ、ビルド出力に使う固定長のリビジョン接尾辞を作成します。

デプロイ情報を記録する

完全なハッシュを別途保持しながら、デプロイ画面やリリースノートには読みやすいコミット接頭辞を表示します。

ログの参照形式を統一する

すべてのサービスで明示した短縮文字数を使用し、リビジョン参照を比較しやすくします。

よくある質問

料金はいくらですか？

APIの料金は1リクエストあたり$0.002です。同じ決定論的な処理を、このページのブラウザー内でも実行できます。

どのGitハッシュ形式に対応していますか？

40文字の完全な16進SHA-1オブジェクトID、または64文字の完全なSHA-256オブジェクトIDが必要です。

短いハッシュでコミットを一意に識別できますか？

常に一意とは限りません。一意性は対象リポジトリ内のほかのオブジェクトに依存し、この機能はリポジトリを調査しません。

指定した長さが大きすぎる場合はどうなりますか？

入力エラーとなり、要求された長さと完全なハッシュで利用できる長さが示されます。

16進英字の大文字は小文字に変換されますか？

いいえ。16進入力を検証し、渡された接頭辞の大文字と小文字を正確に維持します。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/dev/commit-hash-short-form

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/dev/commit-hash-short-form \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"commit_hash":"8f14e45fceea167a5a36dedd4bea2543d2f6b721","length":12}'

const res = await fetch("https://api.kit.forhosting.com/dev/commit-hash-short-form", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "commit_hash": "8f14e45fceea167a5a36dedd4bea2543d2f6b721",
    "length": 12
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/commit-hash-short-form",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "commit_hash": "8f14e45fceea167a5a36dedd4bea2543d2f6b721",
    "length": 12
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/commit-hash-short-form", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"commit_hash":"8f14e45fceea167a5a36dedd4bea2543d2f6b721","length":12}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"commit_hash":"8f14e45fceea167a5a36dedd4bea2543d2f6b721","length":12}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/commit-hash-short-form", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "commit_hash": "8f14e45fceea167a5a36dedd4bea2543d2f6b721",
  "length": 12
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.commit_hash_short_form",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →