Déploiements

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

Toute la documentation GitHub est open source. Vous voyez quelque chose qui n’est pas correct ou qui n’est pas clair ? Envoyez une demande de tirage.

Aidez-nous à rendre ces documents formidables !

Actions

Entrez un terme de recherche pour le trouver dans la documentation GitHub.

Déploiements - GitHub AE Docs

Utilisez l’API REST pour créer et supprimer des clés de déploiement, des déploiements et des environnements de déploiement.

Démarrage rapide

Comparaison des API de GitHub

Ressources disponibles dans l’API REST

Rate limits

Types de médias

Authentification

Sécurisation des informations d’identification de l’API

Résolution des problèmes

Libraries

Types d’événement de problème

Types d’événements GitHub

Points de terminaison pour les jetons d’installation d’application GitHub

Points de terminaison pour les jetons d’utilisateur d’application GitHub

Autorisations pour les applications GitHub

Vue d’ensemble

Utilisation de l’API

Écrire des scripts avec JavaScript

Script avec Ruby

Découvrir les ressources pour un utilisateur

Livraison de déploiements

Rendu des données sous forme de graphes

Utilisation des commentaires

Pagination

Création d’un serveur CI

Bonnes pratiques

Bien démarrer - Base de données Git

Bien démarrer - Vérifications

Chiffrer des secrets

Guides

Artifacts

Autorisations

Secrets

Groupes d’exécuteurs auto-hébergés

Exécuteurs auto-hébergés

Travaux de workflow

Workflow runs

Workflows

Événements

Flux

Notifications

Attribution d’étoiles

Visionnage

Activité

Applications GitHub

Installations

Autorisations OAuth

Webhooks

Applications

Branches

Branches protégées

Exécutions de vérifications

Suites de vérifications

Vérifications

Analyse du code

Codes of conduct

Collaborateurs

Invitations

Commits

Commentaires de commit

États de validation

Clés de déploiement

Stratégies de branche de déploiement

Environnements

États des déploiements

Emojis

Statistiques d’administration

Annonce

Journal d’audit

Webhooks globaux

Licence

Organisations

Environnements de pré-réception

Utilisateurs

Administration d’entreprise

Gists

Commentaires

Objets blob

Références

Étiquettes

Arborescences

Base de données Git

Gitignore

Problèmes

Personnes responsables

Étapes majeures

Durée

Licences

Markdown

Statistiques

Mesures

Migrations

Membres

Collaborateurs externes

Pages

Boards

Cartes

Colonnes

Project boards

Tirages

Commentaires d’évaluation

Passer en revue les demandes

Révisions

Limite du taux

Réactions

Publications

Ressources de mise en production

Liens automatiques

Contenu

Fourches

Git LFS

Référentiels

Rechercher

Analyse de secrets

Teams

Commentaires de discussion

Discussions

Groupes externes

Abonnés

Clés GPG

Clés SSH Git

API REST

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>."