add comments

hashicorp · Jan 15, 2025 · b50ca5e · b50ca5e
1 parent dc5556b
commit b50ca5e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/.github/workflows/build-sitemap.yml b/.github/workflows/build-sitemap.yml
@@ -10,6 +10,7 @@ jobs:
   build-sitemap:
     runs-on: ubuntu-latest
     steps:
+      - name: Check out branch
       - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
 
       - name: Set up node

diff --git a/scripts/build-sitemap.ts b/scripts/build-sitemap.ts
@@ -8,6 +8,11 @@ const envConfigPath = path.join(process.cwd(), 'config', `${env}.json`)
 
 const __config = unflatten(getHashiConfig(envConfigPath))
 
+/**
+ * This script is run as part of the Build sitemap github action that runs on PRs and
+ * pushes to main. To run this script manually, you can run the following command:
+ * `npx hc-tools ./scripts/build-sitemap.ts`
+ */
 async function main() {
 	try {
 		await allDocsFields(__config)