Skip to content

Commit 4931381

Browse files
lane-wetmorelane-wetmore
authored
Merge branch 'main' into lane-wetmore/single-item-recovery
2 parents a210335 + 38664d5 commit 4931381

File tree

892 files changed

+47762
-206
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

892 files changed

+47762
-206
lines changed

‎.github/PULL_REQUEST_TEMPLATE/hcp_pull_request_template.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
## Description
2+
3+
<!-- ID for Jira ticket e.g [SPE-1234] -->
4+
5+
:ticket: [Jira ticket]
6+
7+
<!-- Add a brief description of changes here. Include any other necessary relevant links -->
8+
9+
<!-- Help your reviewer understand the type of review you need by selecting the scope and urgency. -->
10+
11+
### Requested review scope:
12+
13+
- [ ] Content touched by the PR _only_ (typos, clarifications, tips)
14+
- [ ] Code test (command and code block changes)
15+
- [ ] Flow and language near changes (new/rearranged steps)
16+
- [ ] Review everything (rewrites, major changes)
17+
18+
### Review urgency:
19+
20+
- [ ] ASAP (bug fixes, broken content, imminent releases)
21+
- [ ] 3 days (small changes, easy reviews)
22+
- [ ] 1 week (default)
23+
- [ ] Best effort (very non-urgent)
24+
25+
<!-- Fill out only the appropriate checklist for your type of feature (or both if necessary) and delete the other one! -->
26+
27+
## All updates:
28+
29+
<!-- This section is mandatory for all PRs: -->
30+
31+
I have:
32+
33+
- [ ] Verified that all status checks have passed
34+
- [ ] Verified that preview environment has successfully deployed
35+
- [ ] Verified appropriate `label` applied (`hcp` + `product name`)
36+
- [ ] Added all required reviewers (code owners and external)
37+
38+
## Content checklist (optional)
39+
40+
Please do these things before requesting a review. I have:
41+
42+
- [ ] Made any associated code repositories public
43+
- [ ] Added the `hashicorp-education/teamName` to any additional code or example repos as repo admin
44+
- [ ] Added redirects for any moved or removed pages
45+
- [ ] Spell checked the tutorial(s)
46+
- [ ] Followed the [unified style guide](https://github.com/hashicorp/web-unified-docs/tree/main/docs/style-guide)
47+
- [ ] Linted code snippets (Details per language [here](https://github.com/hashicorp/engineering-docs/blob/master/writing/markdown.md#code-blocks))
48+
- [ ] Checked the steps for completeness (no steps are implied or hidden)
49+
- [ ] Looked at the local or vercel build and checked each new or changed page for:
50+
- display on the product curriculum page
51+
- callout box formatting
52+
- code block highlighting
53+
- right-hand navigation
54+
- next and back buttons
55+
- URL path

‎.github/actions/reload-dev-portal/action.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ inputs:
2020
description: 'Revalidate token'
2121
required: true
2222
type: string
23+
bot-bypass-token:
24+
description: 'Bot bypass token'
25+
required: true
26+
type: string
2327

2428
runs:
2529
using: "composite"
@@ -73,8 +77,10 @@ runs:
7377
env:
7478
url: 'https://developer.hashicorp.com/api/revalidate/paths'
7579
auth: 'Authorization: Bearer ${{ inputs.revalidate-token }}'
80+
bot-bypass: '${{ inputs.bot-bypass-token }}'
7681
run: |
7782
curl -X POST "${{ env.url }}" \
7883
-H "${{ env.auth }}" \
7984
-H "Content-Type: application/json" \
85+
-H "X-BOT-BYPASS: ${{ env.bot-bypass }}" \
8086
-d '{"paths": ${{ steps.map-files.outputs.FILES_URLS }} }'

‎.github/labeler.yml‎

Lines changed: 119 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,77 @@
11
# Copyright (c) HashiCorp, Inc.
22
# SPDX-License-Identifier: BUSL-1.1
33

4+
# Add 'Boundary' label to changes under 'content/boundary'
5+
#
6+
# Label | Rule
7+
# --------------- | ------------------------------------------------------------
8+
# Boundary | Default; applies to all doc updates
9+
# Boundary | Updates on HCP Boundary in hcp-docs directory
10+
11+
Boundary:
12+
- any:
13+
- changed-files:
14+
- any-glob-to-any-file: [
15+
'content/boundary/**',
16+
'content/hcp-docs/content/docs/boundary/**'
17+
]
18+
19+
# Add 'Consul' label to changes under 'content/consul'
20+
#
21+
# Label | Rule
22+
# --------------- | ------------------------------------------------------------
23+
# Consul | Default; applies to all doc updates
24+
# Consul | Updates on HCP Consul in hcp-docs directory
25+
26+
Consul:
27+
- any:
28+
- changed-files:
29+
- any-glob-to-any-file: [
30+
'content/consul/**',
31+
'content/hcp-docs/content/docs/consul/**'
32+
]
33+
34+
# Add 'HCP' label to changes under 'content/hcp-docs'
35+
#
36+
# Label | Rule
37+
# --------------- | ------------------------------------------------------------
38+
# HCP | Default; applies to all doc updates
39+
40+
HCP:
41+
- any:
42+
- changed-files:
43+
- any-glob-to-any-file: [
44+
'content/hcp-docs/**'
45+
]
46+
47+
# Add 'Packer' label to changes under 'content/packer'
48+
#
49+
# Label | Rule
50+
# --------------- | ------------------------------------------------------------
51+
# Packer | Default; applies to all doc updates
52+
# Packer | Updates on HCP Packer in hcp-docs directory
53+
54+
Packer:
55+
- any:
56+
- changed-files:
57+
- any-glob-to-any-file: [
58+
'content/packer/**',
59+
'content/hcp-docs/content/docs/packer/**'
60+
]
61+
62+
# Add 'Sentinel' label to changes under 'content/sentinel'
63+
#
64+
# Label | Rule
65+
# --------------- | ------------------------------------------------------------
66+
# Sentinel | Default; applies to all doc updates
67+
68+
Sentinel:
69+
- any:
70+
- changed-files:
71+
- any-glob-to-any-file: [
72+
'content/sentinel/**'
73+
]
74+
475
# Add a Terraform label to changes under the related folders:
576
#
677
# Folder | Labels
@@ -66,19 +137,35 @@ TF Plugin Framework:
66137
'content/terraform-plugin-framework/**'
67138
]
68139

140+
# Add 'Vagrant' label to changes under 'content/vagrant'
141+
#
142+
# Label | Rule
143+
# --------------- | ------------------------------------------------------------
144+
# Vagrant | Default; applies to all doc updates
145+
# Vagrant | Updates on HCP Vagrant in hcp-docs directory
146+
147+
Vagrant:
148+
- any:
149+
- changed-files:
150+
- any-glob-to-any-file: [
151+
'content/vagrant/**',
152+
'content/hcp-docs/content/docs/vagrant/**'
153+
]
69154

70-
# Add 'Vault' label to changes under 'content/vault'
155+
# Add 'Vault' label to changes under 'content/vault', and 'content/hcp-docs/content/docs/vault'
71156
#
72157
# Label | Rule
73158
# --------------- | ------------------------------------------------------------
74159
# Vault | Default; applies to all doc updates
160+
# Vault | Updates on HCP Vault Dedicated in hcp-docs directory
75161
# Vault IC update | Updates on "Important changes" related docs
76162

77163
Vault:
78164
- any:
79165
- changed-files:
80166
- any-glob-to-any-file: [
81-
'content/vault/**'
167+
'content/vault/**',
168+
'content/hcp-docs/content/docs/vault/**'
82169
]
83170

84171
Vault IC:
@@ -91,6 +178,19 @@ Vault IC:
91178
'content/vault/*/content/docs/updates/lts-tracker.mdx'
92179
]
93180

181+
# Add 'Vault Radar' label to changes under 'content/hcp-docs/content/docs/vault-radar'
182+
#
183+
# Label | Rule
184+
# --------------- | ------------------------------------------------------------
185+
# Vault Radar | Default; applies to all doc updates
186+
187+
Vault Radar:
188+
- any:
189+
- changed-files:
190+
- any-glob-to-any-file: [
191+
'content/hcp-docs/content/docs/vault-radar/**'
192+
]
193+
94194
# Add 'WAF' label to changes under 'content/well-architected-framework'
95195
#
96196
# Label | Rule
@@ -104,15 +204,28 @@ WAF:
104204
'content/well-architected-framework/**'
105205
]
106206

107-
# Add 'Sentinel' label to changes under 'content/sentinel'
207+
# Add 'Waypoint' label to changes under 'content/hcp-docs/content/docs/waypoint'
108208
#
109209
# Label | Rule
110210
# --------------- | ------------------------------------------------------------
111-
# Sentinel | Default; applies to all doc updates
211+
# Waypoint | Default; applies to all doc updates
112212

113-
Sentinel:
213+
Waypoint:
114214
- any:
115215
- changed-files:
116216
- any-glob-to-any-file: [
117-
'content/sentinel/**'
217+
'content/hcp-docs/content/docs/waypoint/**'
218+
]
219+
220+
# Add 'HCP Docs' label to changes under 'content/hcp-docs'
221+
#
222+
# Label | Rule
223+
# --------------- | ------------------------------------------------------------
224+
# HCP Docs | Default; applies to all doc updates
225+
226+
HCP Docs:
227+
- any:
228+
- changed-files:
229+
- any-glob-to-any-file: [
230+
'content/hcp-docs/**'
118231
]

‎.github/pull_request_template.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Please go to the `Preview` tab and select the appropriate template:
2+
3+
* [HCP services](?expand=1&template=hcp_pull_request_template.md)
4+
* [Terraform Enterprise](?expand=1&template=ptfe_release_pull_request_template.md)

‎.github/workflows/create-ga-pr.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: 📁 Create GA PR
2+
run-name: Create GA PR [${{ github.actor }}]
3+
4+
permissions:
5+
pull-requests: write
6+
contents: write
7+
8+
on:
9+
workflow_dispatch:
10+
inputs:
11+
targetVersion:
12+
required: true
13+
description: Preview version (e.g., "1.21.x")
14+
default: ''
15+
folderTag:
16+
required: true
17+
default: ''
18+
description: Preview dog tag (e.g., 'rc' or 'beta')
19+
product:
20+
required: true
21+
default: ''
22+
description: Product slug (e.g., 'vault')
23+
24+
env:
25+
prBranch: "${{ github.event.inputs.product }}/${{ github.event.inputs.targetVersion }}-to-ga"
26+
oldFolder: "v${{ github.event.inputs.targetVersion }} (${{ github.event.inputs.folderTag }})"
27+
newFolder: "v${{ github.event.inputs.targetVersion }}"
28+
29+
30+
jobs:
31+
32+
update-folder:
33+
runs-on: ubuntu-latest
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
steps:
37+
- name: Check out main
38+
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
39+
with:
40+
fetch-depth: 0
41+
- name: Configure Git User
42+
run: |
43+
git config user.name "GitHub Actions"
44+
git config user.email "team-rel-eng@hashicorp.com"
45+
- name: Update preview folder
46+
working-directory: ./content/${{ github.event.inputs.product }}
47+
run: |
48+
git pull origin main
49+
git checkout -B "${{ env.prBranch }}"
50+
mv "./${{ env.oldFolder }}" "./${{ env.newFolder }}"
51+
git add .
52+
git commit -m "Rename ${{ env.oldFolder }}"
53+
git push --force -u origin "${{ env.prBranch }}"
54+
55+
create-pr:
56+
runs-on: ubuntu-latest
57+
env:
58+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
59+
prTitle: "[PUBLISH GA] Convert ${{ github.event.inputs.targetVersion }} to GA"
60+
prBody: |
61+
🚧 \`${{ github.repository }}\` publication PR
62+
63+
**Triggered by**: @${{ github.actor }} with a Github action
64+
**Preview folder**: \`${{ github.event.inputs.product }}/v${{ github.event.inputs.targetVersion }} (${{ github.event.inputs.folderTag }})\`
65+
**New folder**: \`${{ github.event.inputs.product }}/v${{ github.event.inputs.targetVersion }}\`
66+
steps:
67+
- name: Check out repository code
68+
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
69+
with:
70+
ref: ${{ env.prBranch }}
71+
fetch-depth: 0
72+
- name: Create pull request
73+
run: |
74+
gh pr create \
75+
--base main \
76+
--head ${{ env.prBranch }} \
77+
--title "${{ env.prTitle }}" \
78+
--body "${{ env.prBody }}"
79+
- name: Wrap-up
80+
run: |
81+
echo "🍏 Final job status: ${{ job.status }}"

‎.github/workflows/deploy-udr.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,4 @@ jobs:
5858
head_sha: ${{ github.event.after }}
5959
dev-portal-deploy-hook-prod: ${{ secrets.DEV_PORTAL_DEPLOY_HOOK_PROD }}
6060
revalidate-token: ${{ secrets.REVALIDATE_TOKEN }}
61+
bot-bypass-token: ${{ secrets.DEVELOPER_BOT_BYPASS_TOKEN }}

‎.github/workflows/force-reload-dev-portal.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ jobs:
3131
head_sha: ${{ inputs.head_sha }}
3232
dev-portal-deploy-hook-prod: ${{ secrets.DEV_PORTAL_DEPLOY_HOOK_PROD }}
3333
revalidate-token: ${{ secrets.REVALIDATE_TOKEN }}
34+
bot-bypass-token: ${{ secrets.DEVELOPER_BOT_BYPASS_TOKEN }}

‎CODEOWNERS‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,19 @@
3838
# Well-architected framework
3939

4040
/content/well-architected-framework/ @hashicorp/well-architected-education-approvers
41+
42+
43+
# HCP-docs documentation ownership
44+
# HCP Consul Docs
45+
/content/hcp-docs/content/docs/consul/* @hashicorp/consul-docs
46+
47+
# HCP Vault & HCP Vault Secrets docs
48+
/content/hcp-docs/content/docs/vault/* @hashicorp/vault-education-approvers
49+
/content/hcp-docs/content/docs/vault-secrets/* @hashicorp/vault-education-approvers
50+
51+
# HCP Boundary docs
52+
/content/hcp-docs/content/docs/boundary/* @hashicorp/boundary-education-approvers
53+
54+
#HCP IAM
55+
/content/hcp-docs/content/partials/hcp-administration/* @hashicorp/cloud-access-control @hashicorp/cloud-identity
56+
/content/hcp-docs/content/docs/hcp/iam/* @hashicorp/cloud-access-control @hashicorp/cloud-identity

0 commit comments

Comments
 (0)