Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 4 additions & 0 deletions .copywrite.hcl
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,9 @@ project {
".next/**",
".husky/**",
"next-env.d.ts",
"Gemfile",
"scripts/tfe-releases/tfe-releases-repos.yaml",
"scripts/tfe-releases/app_repos.yaml",
".github/actions/**/out/**",
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Terraform Enterprise <!-- RELEASE_SHORT_TMPL (e.g. vYYYYMM-X) -->

- **App Deadline Date:** <!-- DEADLINE_DATE_TMPL (e.g. Wednesday, December 8, 2021) -->
- **Release Branch:** <!-- RELEASE_BRANCH_TMPL (e.g. ptfe-releases/v202112) -->
- **Release Slack Channel:** #proj-tfe-releases

## Contributor Sign Off

Congratulations, if your name is on this list that means you contributed to this release. You must sign off on your
contributions by checking the box in front of your username. The number in front of your username is the number of pull
requests authored by you that are going into this release.

Please review the changelog entries for your contributions. Your changelog entries should be **feature-focused**, define
the **what** and **why**, and include any necessary information for customers. Each changelog entry should make it clear
why the customer should care about the change. More information on
[how to write release notes can be found in confluence](https://hashicorp.atlassian.net/wiki/spaces/TFENG/pages/2369355816/How+to+Write+Release+Notes+for+TFE).

Place your changelog entry into one of the following categories.

- **Known Issues:** Issues present in this release. Ideally each issue will describe a workaround or provide information
on which release resolves the issue. This category is typically added after a release is published.

- **Breaking Changes:** Changes that will require a customer to take some action to modify their workflow, processes,
monitoring, etc.

- **Deprecations:** Things that will no longer be supported by the application. Can be operating systems going
end-of-life, settings being removed, etc.

- **Highlights:** Noteworthy changes that the customer should see when reading the release notes. These should be
approved by your Product Manager and/or Engineering Manager.

- **Features:** Newly added functionality to the application.

- **Improvements:** Updates to existing components of the application.

- **Bug Fixes:** Fixes to issues reported with the application.

- **Security:** Security enhancements to the application and its infrastructure and patches for Common Vulnerabilities
and Exposures (CVEs).

When you are finished reviewing your contributions, check the box next to your name.

<!-- CONTRIBUTORS_TMPL: paste contributor list -->

Please let @hashicorp/technical-program-mgmt know if you have any questions.
52 changes: 52 additions & 0 deletions .github/actions/copy-cloud-docs-for-tfe/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# `copy-cloud-docs-for-tfe`

This composite action is consumed by the `copy-docs.yml` workflow, which is triggered
at the time of the Terraform Enterprise team's `Create TFE Release Notes` workflow.

## Overview

This action looks for a few things in authored `mdx`, to determine
if sections or entire pages should be ignored from this copy process.

### Frontmatter

Adding a `tfc_only: true` line in markdown frontmatter signals to
the action that the associated `.mdx` file should not be handled in the copy process.

#### Example

```markdown
---
page_title: Assessments - API Docs - Terraform Cloud
tfc_only: true
description: >-
Assessment results contain information about continuous validation in
Terraform Cloud, like drift detection.
---
```

### HTML Comments

Specially formatted HTML comments can be used in matching pairs
to omit multiple **lines** of text from the copy process.

> **Warning**: This only works with MDX v1.

#### Example

```markdown
Some content available in both TFC & TFE...

<!-- BEGIN: TFC:only -->
## Some section

This will only be visible in TFC

<!-- END: TFC:only -->

More content available in both TFC & TFE...
```

> **Note**: More details are available in this [TFC/TFE Content exclusion][rfc] RFC.

[rfc]: https://docs.google.com/document/d/1DPJU6_7AdGIJVlwJUWBlRqREmYon2IgYf_DrtKjhkcE/edit
18 changes: 18 additions & 0 deletions .github/actions/copy-cloud-docs-for-tfe/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: BUSL-1.1

name: Copy cloud-docs for TFE
description: Copy docs/nav-data/assets from source dir to target dir
runs:
using: 'node20'
main: 'out/index.js'
inputs:
source_path:
required: true
description: 'The path to source HCP terraform files from'
target_path:
required: true
description: 'The path to copy over HCP terraform files to'
new_TFE_version:
required: false
description: 'The new TFE version to create and copy docs into.'
18 changes: 18 additions & 0 deletions .github/actions/copy-cloud-docs-for-tfe/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: BUSL-1.1
*/

import * as core from '@actions/core'

import { main } from './main'

async function action() {
const sourcePath = core.getInput('source_path')
const targetPath = core.getInput('target_path')
const newTFEVersion = core.getInput('new_TFE_version')

await main(sourcePath, targetPath, newTFEVersion)
}

action()
Loading
Loading