Bereitstellungen

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Alle GitHub-Dokumente sind Open Source-Dokumente. Ist dir etwas Falsches oder Unklares aufgefallen? Bitte sende einen Pull Request.

Hilf uns, diese Dokumente perfekt zu machen!

Aktionen

Gib einen Suchbegriff ein, um ihn in der GitHub-Dokumentation zu finden.

Bereitstellungen - GitHub AE Docs

Mit der REST-API kannst du Bereitstellungsschlüssel, Bereitstellungen und Bereitstellungsumgebungen erstellen und löschen.

Schnellstart

Vergleich der GitHub-APIs

Ressourcen in der REST-API

Rate limits

Medientypen

Authentifizierung

Schützen von API-Anmeldeinformationen

Problembehandlung

Libraries

Issue-Ereignistypen

GitHub-Ereignistypen

Endpunkt für GitHub-App-Installationszugriffstoken

Endpunkte für GitHub-App-Benutzertoken

Berechtigungen für GitHub-Apps

Übersicht

Verwenden der API

Erstellen von Skripts mit JavaScript

Skript mit Ruby

Ermitteln von Ressourcen für einzelne Benutzer*innen

Übermitteln von Bereitstellungen

Rendern von Daten als Graphen

Arbeiten mit Kommentaren

Paginierung

Erstellen eines CI-Servers

Bewährte Methoden

Erste Schritte: Git-Datenbank

Erste Schritte: Überprüfungen

Verschlüsseln von Geheimnissen

Anleitungen

Artifacts

Berechtigungen

Geheimnisse

Selbstgehostete Runnergruppen

Selbstgehostete Runner

Workflowaufträge

Workflowausführungen

Workflows

Events

Feeds

Benachrichtigungen

Versehen mit einem Stern

Watching (Überwachung)

Aktivität

GitHub Apps

Installationen

OAuth-Autorisierungen

webhooks

Apps

Branches

Geschützte Branches

Überprüfungsausführungen

Prüfsuiten

Prüfungen

Codeüberprüfung

Verhaltensregeln

Projektmitarbeiter

Einladungen

Commits

Commit-Kommentare

Commitstatus

Schlüssel bereitstellen

Richtlinien für Bereitstellungsbranches

Umgebungen

Bereitstellungsstatus

Emojis

Administratorstatistiken

Ankündigung

Überwachungsprotokoll

Globale Webhooks

Lizenz

Organisationen

Pre-Receive-Umgebungen

Benutzer

Enterprise-Verwaltung

Gists

Kommentare

BLOBs

References

Strukturen

Git-Datenbank

Gitignore

Probleme

Bearbeiter

Ereignisse

Bezeichnungen

Meilensteine

Zeitachse

Lizenzen

Markdown

Statistik

Metriken

Migrationen

Member

Externe Mitwirkende

Seiten

Boards

Cards

Spalten

Project boards

Pulls

Rezensionskommentare

Reviewanfragen

Überprüfungen

Rate Limit

Reaktionen

Releases

Releaseressourcen

Autolinks

Inhalte

Radgabeln

Git LFS

Repositorys

Webhooks

Suchen,

Geheime Überprüfung

Teams

Diskussionskommentare

Diskussionen

Externe Gruppen

Follower

GPG-Schlüssel

Git-SSH-Schlüssel

REST-API

A request for a specific ref(branch,sha,tag) to be deployed

Deployment

Simple filtering of deployments is available via query parameters:

The account owner of the repository. The name is not case sensitive.

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

The SHA recorded at creation time.

The name of the ref. This can be a branch, tag, or SHA.

The name of the task for the deployment (e.g., <code>deploy</code> or <code>deploy:migrations</code>).

task

The name of the environment that was deployed to (e.g., <code>staging</code> or <code>production</code>).

environment

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

List deployments

The ref to deploy. This can be a branch, tag, or SHA.

Specifies a task to execute (e.g., <code>deploy</code> or <code>deploy:migrations</code>).

Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

auto_merge

The <a href="https://docs.github.com/github-ae@latest/rest/commits/statuses">status</a> contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

required_contexts

JSON payload with extra information about the deployment.

payload

Name for the target deployment environment (e.g., <code>production</code>, <code>staging</code>, <code>qa</code>).

Short description of the deployment.

description

Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: <code>false</code>

transient_environment

Specifies if the given environment is one that end-users directly interact with. Default: <code>true</code> when <code>environment</code> is <code>production</code> and <code>false</code> otherwise.

production_environment

Name for the target deployment environment.

Specifies if the given environment is one that end-users directly interact with. Default: false.

The ref to deploy. This can be a branch, tag, or sha.

Specifies if the given environment is will no longer exist at some point in the future. Default: false.

Deployments offer a few configurable parameters with certain defaults.
The <code>ref</code> parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them
before we merge a pull request.
The <code>environment</code> parameter allows deployments to be issued to different runtime environments. Teams often have
multiple environments for verifying their applications, such as <code>production</code>, <code>staging</code>, and <code>qa</code>. This parameter
makes it easier to track which environments have requested deployments. The default environment is <code>production</code>.
The <code>auto_merge</code> parameter is used to ensure that the requested ref is not behind the repository's default branch. If
the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,
the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will
return a failure response.
By default, <a href="https://docs.github.com/github-ae@latest/rest/commits/statuses">commit statuses</a> for every submitted context must be in a <code>success</code>
state. The <code>required_contexts</code> parameter allows you to specify a subset of contexts that must be <code>success</code>, or to
specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do
not require any contexts or create any commit statuses, the deployment will always succeed.
The <code>payload</code> parameter is available for any extra information that a deployment system might need. It is a JSON text
field that will be passed on when a deployment event is dispatched.
The <code>task</code> parameter is used by the deployment system to allow different execution paths. In the web world this might
be <code>deploy:migrations</code> to run schema changes on the system. In the compiled world this could be a flag to compile an
application with debugging enabled.
Users with <code>repo</code> or <code>repo_deployment</code> scopes can create a deployment for a given ref.
Merged branch response:
You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating
a deployment. This auto-merge happens when:
<ul>
<li>Auto-merge option is enabled in the repository</li>
<li>Topic branch does not include the latest changes on the base branch, which is <code>master</code> in the response example</li>
<li>There are no merge conflicts</li>
</ul>
If there are no new commits in the base branch, a new request to create a deployment should give a successful
response.
Merge conflict response:
This error happens when the <code>auto_merge</code> option is enabled and when the default branch (in this case <code>master</code>), can't
be merged into the branch that's being deployed (in this case <code>topic-branch</code>), due to merge conflicts.
Failed commit status checks:
This error happens when the <code>required_contexts</code> parameter indicates that one or more contexts need to have a <code>success</code>
status for the commit to be deployed, but one or more of the required contexts do not have a state of <code>success</code>.

Conflict when there is a merge conflict or the commit's status checks failed

Validation failed, or the endpoint has been spammed.

Create a deployment

deployment_id

Get a deployment

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with <code>repo</code> or <code>repo_deployment</code> scopes can delete a deployment.
To set a deployment as inactive, you must:
<ul>
<li>Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.</li>
<li>Mark the active deployment as inactive by adding any non-successful deployment status.</li>
</ul>
For more information, see "<a href="https://docs.github.com/github-ae@latest/rest/deployments/deployments/#create-a-deployment">Create a deployment</a>" and "<a href="https://docs.github.com/github-ae@latest/rest/deployments/statuses#create-a-deployment-status">Create a deployment status</a>."