You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/workflows/infrastructure-group/publish-tfe-docs.md
+25-9Lines changed: 25 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,17 @@ This page describes the process for publishing Terraform Enterprise documentatio
6
6
7
7
The team releases a milestone or major version once a quarter and releases patches as they become available.
8
8
9
+
## Artifacts for next major release
10
+
11
+
After the release of a major verson, the release engineer runs a GitHub [workflow]((https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/copy-cloud-docs-for-tfe.yml)) in the `web-unified-docs-internal` repository that creates the following artifacts:
12
+
13
+
- A branch named `tfe-release/<milestone>.<major>.x` for assembling the release notes and documentation updates. This is the branch that you merge into `main` to publish the docs.
14
+
- A branch named `HCPTF-diff/<milestone>.<major>.x` that contains a diff of all of the new content from HCP TF slated for the next Terraform Enterprise release. This branch will be updated with latest changes before next release.
15
+
- A PR named `HCP TF changes for TFE release <milestone>.<major>.x` for merging content updates into the release notes into the assembly branch. Review this PR and merge into the assembly branch.
16
+
- A PR named `TFE Release <milestone>.<major>.x` for merging the release notes into the assembly branch.
17
+
18
+
Refer to the [TFE Release 1.0.0](https://github.com/hashicorp/web-unified-docs-internal/pull/299) to see examples of the app deadline artifacts.
19
+
9
20
## Get the release date
10
21
11
22
Check the `#proj-tfe-releases` channel for a message from the team manager about important dates. For example:
@@ -20,14 +31,7 @@ More details -
20
31
21
32
Ask for the dates in the channel if it has been more than six weeks since the last milestone or major version and the manager hasn't posted the dates yet. You should also verify that the dates haven't changed closer to the standing date.
22
33
23
-
**Application Code Deadline**: Also called **app deadline**, this is the Terraform Enterprise code freeze and occurs 1.5 to 2 weeks before the release date. App deadline is also when the release engineer runs a GitHub workflow in the `web-unified-docs-internal` repository that creates the following artifacts:
24
-
25
-
- A branch named `tfe-release/<milestone>.<major>.x` for assembling the release notes and documentation updates. This is the branch that you merge into `main` to publish the docs.
26
-
- A branch named `HCPTF-diff/<milestone>.<major>.x` that contains a diff of all of the new content from HCP TF slated for the next Terraform Enterprise release.
27
-
- A PR named `HCP TF changes for TFE release <milestone>.<major>.x` for merging content updates into the release notes into the assembly branch. Review this PR and merge into the assembly branch.
28
-
- A PR named `TFE Release <milestone>.<major>.x` for merging the release notes into the assembly branch.
29
-
30
-
Refer to the [TFE Release 1.0.0](https://github.com/hashicorp/web-unified-docs-internal/pull/299) to see examples of the app deadline artifacts.
34
+
**Application Code Deadline**: Also called **app deadline**, this is the Terraform Enterprise code freeze and occurs 1.5 to 2 weeks before the release date. App deadline is also when the release engineer runs a GitHub [workflow]((https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/create-tfe-release-notes.yml)) in the `web-unified-docs-internal` repository. The workkflow creates the release notes and updates the `HCPTF-diff/<milestone>.<major>.x` branch with latest changes from terraform common docs.
31
35
32
36
**Backport Deadline**: This is an engineering deadline and isn't actionable for IPG team members.
33
37
@@ -62,7 +66,19 @@ This section contains supplementary information for publishing Terraform Enterpr
62
66
63
67
### Manually create docs artifacts for the release
64
68
65
-
The [Create TFE Release Notes](https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/create-tfe-release-notes.yml) action creates the release notes PR and triggers the [Copy Cloud Docs For TFE](https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/copy-cloud-docs-for-tfe.yml) action. These actions create the branches and PRs necessary for publishing a new version of the Terraform Enterprise documenation. Complete the following steps to manually run the actions:
69
+
#### Create the artifacts for next release
70
+
71
+
The [Copy Cloud Docs For TFE](https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/copy-cloud-docs-for-tfe.yml) action creates the branches and PRs necessary for publishing a new version of the Terraform Enterprise documenation. Complete the following steps to manually run the actions:
72
+
73
+
1. Log into GitHub and navigate to the `web-unified-docs-internal` repository.
74
+
1. Click **Actions**, then choose **Copy Cloud Docs For TFE** from the **Actions** sidebar.
75
+
1. Open the **Run workflow** dropdown and choose the branch to use to run the workflow. This is `main` in almost all cases.
76
+
1. Specify the following values:
77
+
- Enter the upcoming version of the TFE release.
78
+
79
+
#### Create the release notes PR
80
+
81
+
The [Create TFE Release Notes](https://github.com/hashicorp/web-unified-docs-internal/actions/workflows/create-tfe-release-notes.yml) action creates the release notes PR. Complete the following steps to manually run the actions:
66
82
67
83
1. Log into GitHub and navigate to the `web-unified-docs-internal` repository.
68
84
1. Click **Actions**, then choose **Create TFE Release Notes** from the **Actions** sidebar.
0 commit comments