Gitignore

Verwende die REST-API, um Vorlagen vom Typ .gitignore abzurufen, die zum Ignorieren von Dateien und Verzeichnissen verwendet werden können.

Informationen zu gitignore

Wenn du ein neues Repository in deine GitHub Enterprise Server-Instanz über die API erstellst, kannst du eine GITIGNORE-Vorlage festlegen, die beim Erstellen auf das Repository angewendet werden soll. Du kannst die REST-API zum Abrufen von GITIGNORE-Vorlagen aus dem .gitignore-Repository auf GitHub Enterprise Server verwenden.

Du kannst den benutzerdefinierten Medientyp application/vnd.github.raw beim Abrufen einer GITIGNORE-Vorlage verwenden. Weitere Informationen findest du unter Medientypen.

Get all gitignore templates

Funktioniert mit GitHub Apps

List all templates available to pass as an option when creating a repository.

HTTP-Antwortstatuscodes für „Get all gitignore templates“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified

Codebeispiele für „Get all gitignore templates“

get/gitignore/templates

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gitignore/templates

Response

Status: 200

[
  "Actionscript",
  "Android",
  "AppceleratorTitanium",
  "Autotools",
  "Bancha",
  "C",
  "C++"
]

Get a gitignore template

Funktioniert mit GitHub Apps

The API also allows fetching the source of a single template. Use the raw media type to get the raw contents.

Parameter für „Get a gitignore template“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.
Pfadparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich

HTTP-Antwortstatuscodes für „Get a gitignore template“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified

Codebeispiele für „Get a gitignore template“

get/gitignore/templates/{name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/gitignore/templates/NAME

Response

Status: 200

{
  "name": "C",
  "source": "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"
}