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
+56-30Lines changed: 56 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Terraform Enterprise quarterly releases
2
2
3
-
This page describes the process for publishing Terraform Enterprise documentation. Terraform Enterprise adheres to the following semantic versioning scheme:
3
+
This page describes the process for publishing Terraform Enterprise documentation. Terraform Enterprise adheres to the following semantic versioning scheme:
4
4
5
5
`MILESTONE.MAJOR.PATCH`
6
6
@@ -18,34 +18,34 @@ More details -
18
18
-> GA Release Publish: week of November 9
19
19
```
20
20
21
-
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.
21
+
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
22
23
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
24
25
-
- A branch named `tfe-release/<milestone>.<major>.x` for assemblying 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.
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
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.
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.
31
31
32
32
**Backport Deadline**: This is an engineering deadline and isn't actionable for IPG team members.
33
33
34
34
**GA Release Publish**: On this date, merge the assembly branch into `main` to publish the documentation.
35
35
36
-
## Before app deadline
36
+
## Before app deadline
37
37
38
-
Make sure to merge any PRs against the `terraform-docs-common` folder that should be included in the upcoming Terraform Enterprise release.
38
+
Make sure to merge any PRs against the `terraform-docs-common` folder that should be included in the upcoming Terraform Enterprise release.
39
39
40
40
Apply any exclusion tags to prevent HCP Terraform-specifc content from publishing to the enterprise docs. Refer to [Exclusion tag syntax](#exclusion-tag-syntax) for details.
41
41
42
42
## Before GA release
43
-
44
-
Review and merge the `HCP TF changes for TFE release <milestone>.<major>.x` PR into the `tfe-release/<milestone>.<major>.x` branch. During your review, verify that all of the changes are appropriate for Terraform Enterprise. If you’re unsure about an item, you can also ask in `#proj-tfe-releases`.
43
+
44
+
Review and merge the `HCP TF changes for TFE release <milestone>.<major>.x` PR into the `tfe-release/<milestone>.<major>.x` branch. During your review, verify that all of the changes are appropriate for Terraform Enterprise. If you’re unsure about an item, you can also ask in `#proj-tfe-releases`.
45
45
46
46
If you need to address poorly-written content or if you need to apply exclusion tags, you must also apply the changes to the corresponding files in the public `web-unified-docs` repository so that the next synchronization doesn't overwrite your changes.
47
47
48
-
Review and merge the `TFE Release <milestone>.<major>.x` release notes PR. The release engineer is responsible for merging the PR. The release engineer also prepares the release notes section of the docs.
48
+
Review and merge the `TFE Release <milestone>.<major>.x` release notes PR. The release engineer is responsible for merging the PR. The release engineer also prepares the release notes section of the docs.
49
49
50
50
Review and merge any other PRs opened against the release branch.
51
51
@@ -55,47 +55,75 @@ The release engineer merges `tfe-release/<milestone>.<major>.x` release branch i
55
55
56
56
---
57
57
58
-
## Apendix
58
+
## Appendix
59
59
60
60
This section contains supplementary information for publishing Terraform Enterprise docs.
61
61
62
-
### Manually create docs artifacts for the release
62
+
### Manually create docs artifacts for the release
63
63
64
64
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:
65
65
66
-
1. Log into GitHub and navigate to the `web-unified-docs-internal` repository.
66
+
1. Log into GitHub and navigate to the `web-unified-docs-internal` repository.
67
67
1. Click **Actions**, then choose **Create TFE Release Notes** from the **Actions** sidebar.
68
68
1. Open the **Run workflow** dropdown and choose the branch to use to run the workflow. This is `main` in almost all cases.
69
69
1. Specify the following values:
70
-
- Enter the upcoming version of the TFE release.
70
+
- Enter the upcoming version of the TFE release.
71
71
- Enter the release branch for the upcoming release. Omit the suffix. You must specify an existing release branch.
72
-
- Enter the tag of the most recent TFE release. The workflow uses this version to generate the change log.
72
+
- Enter the tag of the most recent TFE release. The workflow uses this version to generate the change log.
73
73
74
74
### Exclusion tag syntax
75
75
76
-
Most content in the Terraform Enterprise documentation is sourced from the `terraform-docs-common` folder shared with HCP Terraform, but some features, such as operating HCP Terraform in Europe and tiered pricing, are specific to the SaaS offering. There is also sometimes a lag between when a feature releases in HCP Terraform and lands in Terraform Enterprise. For this reason, you will need to mark content in the `terraform-docs-common` folder as HCP Terraform-only to exclude it from the Terraform Enterprise documentation. Conversely, you can apply an exclusion tag to prevent information that should only appear in Terraform Enterprise.
76
+
Most content in the Terraform Enterprise documentation is sourced from the `terraform-docs-common` folder shared with HCP Terraform, but some features, such as operating HCP Terraform in Europe and tiered pricing, are specific to the SaaS offering. There is also sometimes a lag between when a feature releases in HCP Terraform and lands in Terraform Enterprise. For this reason, you will need to mark content in the `terraform-docs-common` folder as HCP Terraform-only to exclude it from the Terraform Enterprise documentation. Conversely, you can apply an exclusion tag to prevent information that should only appear in Terraform Enterprise.
77
77
78
78
You can exclude page-level content as well as entire MDX files.
79
79
80
-
#### Page-level exclusions
81
-
82
-
Use HTML comment tags to add a `BEGIN:` and an `END:` exclusion directive:
80
+
#### Exclude content on a page
81
+
82
+
Use HTML comment tags and add the `BEGIN: TFC:only` and `END: TFC:only` exclusion directives to exclude content from displaying in the Terraform Enterprise docs:
Except for the `BEGIN:` and `END:` directives, the content of each tag must be identical, otherwise the platform recognizes them as different directives and returns an error.
0 commit comments