Skip to content

Commit f67a0a8

Browse files
jc-clarkstreatsSiaraMist
authored
Add documentation for "Drill deep into your Deployments across Environments" (#39270)
Co-authored-by: Annie Streater <[email protected]> Co-authored-by: Siara <[email protected]>
1 parent 9884730 commit f67a0a8

File tree

4 files changed

+75
-2
lines changed

4 files changed

+75
-2
lines changed

content/actions/deployment/managing-your-deployments/viewing-deployment-history.md

+63-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Viewing deployment history
3-
shortTitle: View deployment history
3+
shortTitle: Deployment history
44
intro: View current and previous deployments for your repository.
55
versions:
66
fpt: '*'
@@ -13,9 +13,68 @@ redirect_from:
1313
- /developers/overview/viewing-deployment-history
1414
- /actions/deployment/viewing-deployment-history
1515
---
16+
{% ifversion actions-deployment-history-beta %}
1617

18+
{% data reusables.actions.deployment-history-beta-note %}
1719

18-
You can deliver deployments through {% data variables.product.prodname_actions %} and environments or with the REST API and third party apps. For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about deployments with the REST API, see "[AUTOTITLE](/rest/repos#deployments)."
20+
## About deployment history
21+
22+
{% data reusables.actions.about-deployment-with-github-actions %}
23+
24+
On the deployments page of your repository, you can view the following aspects of your deployments.
25+
26+
- Currently active deployments across various environments
27+
- Deployments filtered by environment
28+
- Your repository's full deployment history
29+
- Associated commits that triggered the deployment
30+
- Connected {% data variables.product.prodname_actions %} workflow logs
31+
- The deployment URL (if one exists)
32+
- The source pull request and branch related to each deployment
33+
- Deployment statuses. For more information about deployment statuses, see "[AUTOTITLE](/rest/deployments/deployments#about-deployments)."
34+
35+
By default, the deployments page shows currently active deployments from select environments and a timeline of the latest deployments for all environments.
36+
37+
### Viewing your repository's deployment history
38+
39+
In the right-hand sidebar of the home page of your repository, click **Deployments**.
40+
41+
### Viewing an environment's deployment history
42+
43+
To view recent deployments for a specific environment, under **Deployments**, click any currently active or recent environment.
44+
45+
### Viewing commits that triggered deployments
46+
47+
To view the associated commit that triggered the deployment, to the right of the deployment status badge, click the commit message.
48+
49+
{% note %}
50+
51+
**Note:** Deployments from commits originating from a fork outside of the repository will not show links to the source pull request and branch related to each deployment. For more information about forks, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)."
52+
53+
{% endnote %}
54+
55+
### Navigating to deployment URLs
56+
57+
To view the URL for the deployment, to the right of the commit message, click {% octicon "link-external" aria-label="Navigate to deployment URL" %}.
58+
59+
{% note %}
60+
61+
**Note:** If a deployment does not have an associated URL, the {% octicon "link-external" aria-label="Navigate to deployment URL" %} button is not displayed.
62+
63+
{% endnote %}
64+
65+
### Accessing workflow run logs
66+
67+
To navigate to the workflow run logs associated with the deployment, to the right of the commit message, click {% octicon "kebab-horizontal" aria-label="View logs" %}. Then click **View logs**.
68+
69+
{% note %}
70+
71+
**Note:** If a deployment does not have an associated workflow run, the {% octicon "kebab-horizontal" aria-label="View logs" %} button is not displayed.
72+
73+
{% endnote %}
74+
75+
{% else %}
76+
77+
{% data reusables.actions.about-deployment-with-github-actions %}
1978

2079
To view current and past deployments, click **Environments** in the sidebar of the home page of your repository.
2180

@@ -24,3 +83,5 @@ The deployments page displays the last active deployment of each environment for
2483
The activity log shows the deployment history for your environments. By default, only the most recent deployment for an environment has an `Active` status; all previously active deployments have an `Inactive` status. For more information on automatic inactivation of deployments, see "[AUTOTITLE](/rest/deployments#inactive-deployments)."
2584

2685
You can also use the REST API to get information about deployments. For more information, see "[AUTOTITLE](/rest/repos#deployments)."
86+
87+
{% endif %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Reference: #10902
2+
# Beta release for deployment history dashboard "Drill deep into Deployments across Environments"
3+
versions:
4+
fpt: '*'
5+
ghec: '*'
6+
ghes: '>= 3.11'
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
You can deliver deployments through {% data variables.product.prodname_actions %} and environments or with the REST API and third party apps. For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about deployments with the REST API, see "[AUTOTITLE](/rest/repos#deployments)."
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% note %}
2+
3+
**Note:** Deployment history is currently in beta and subject to change.
4+
5+
{% endnote %}

0 commit comments

Comments
 (0)