Gitignore

La API de Gitignore recupera las plantillas de .gitignore que pueden utilizarse para ignorar archivos y directorios.

Cuando creas un repositorio de GitHub AE nuevo a través de la API, puedes especificar una plantilla de .gitignore para que aplique al repositorio cuando éste se cree. La API de plantillas de .gitignore lista y recupera plantillas del repositorio de .gitignore de GitHub AE.

Tipos de medios personalizados para gitignore

Puedes utilizar este tipo de medios personalizado cuando obtengas una plantilla de gitignore.

application/vnd.github.VERSION.raw

Para obtener más información, consulta la sección "Tipos de medios".

Get all gitignore templates

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

get /gitignore/templates

Ejemplos de código

Shell
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/api/v3/gitignore/templates
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates')

Response

Status: 200 OK
[
  "Actionscript",
  "Android",
  "AppceleratorTitanium",
  "Autotools",
  "Bancha",
  "C",
  "C++"
]

Not modified

Status: 304 Not Modified

Notes


Get a gitignore template

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

get /gitignore/templates/{name}

Parámetros

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended.

name string path

Ejemplos de código

Shell
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://{hostname}/api/v3/gitignore/templates/NAME
JavaScript (@octokit/core.js)
await octokit.request('GET /gitignore/templates/{name}', {
  name: 'name'
})

Response

Status: 200 OK
{
  "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"
}

Not modified

Status: 304 Not Modified

Notes


¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.