Add copyright source headers and GHA check (#159)

* Add copyright source headers

* Add check headers GHA

* Use a trusted checkout action version

* test by pushing up a file with no header

* forgot the .js on the file

* Remove test file

Author: RubenSandwich

.copywrite.hcl

@@ -0,0 +1,18 @@
+schema_version = 1
+
+project {
+  license        = "BUSL-1.1"
+  copyright_year = 2024
+
+  header_ignore = [
+    "public/**",
+    "content/**",
+    "docs/**",
+    "__fixtures__/**",
+    "__mocks__/**",
+    "**/*.json",
+    ".next/**",
+    ".husky/**",
+    "next-env.d.ts",
+  ]
+}

.github/actions/get-vercel-preview-data/action.yml

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
 name: Get Vercel Preview Data
 description: Fetches the latest Vercel preview, inspector URL, and created UTC for the specified project's deployment
 runs:

.github/actions/get-vercel-preview-data/dist/index.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 

.github/actions/get-vercel-preview-data/src/index.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import * as core from '@actions/core'
 import fetch from 'node-fetch'
 

.github/workflows/copyright-headers-check.yml

@@ -0,0 +1,26 @@
+name: 'Check Copyright Headers'
+
+on:
+  pull_request:
+    paths:
+      - '**.js'
+      - '**.jsx'
+      - '**.ts'
+      - '**.tsx'
+      - '**.mjs'
+  push:
+    branches: ['main']
+
+jobs:
+  check-headers:
+    name: 'Check Copyright Headers'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Install copywrite
+        uses: hashicorp/setup-copywrite@32638da2d4e81d56a0764aa1547882fc4d209636 # v1.1.3
+
+      - name: Validate Header Compliance
+        run: copywrite headers --plan

Dockerfile

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
 FROM node:20
 
 WORKDIR /server

app/api/all-docs-paths/route.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { expect, test, vi, afterEach } from 'vitest'
 import docsPathsMock from '../../../__fixtures__/docsPathsAllVersionsMock.json'
 import { GET } from './route'

app/api/all-docs-paths/route.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { errorResultToString } from '@utils/result'
 import { getDocsPaths } from '@utils/allDocsPaths'
 import { PRODUCT_CONFIG } from '@utils/productConfig.mjs'

app/api/assets/[productSlug]/[version]/[...assetPath]/route.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { expect, test, vi } from 'vitest'
 import { GET } from './route'
 import { getAssetData } from '@utils/file'

app/api/assets/[productSlug]/[version]/[...assetPath]/route.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { getAssetData } from '@utils/file'
 import { getProductVersion } from '@utils/contentVersions'
 import { errorResultToString } from '@utils/result'

app/api/content-versions/route.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { expect, test, vi, beforeEach, afterEach } from 'vitest'
 import { GET } from './route'
 

app/api/content-versions/route.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { findDocVersions } from '../../utils/findDocVersions'
 import { PRODUCT_CONFIG } from '@utils/productConfig.mjs'
 

app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import {
 	expect,
 	describe,

app/api/content/[productSlug]/doc/[version]/[...docsPath]/route.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { readFile, parseMarkdownFrontMatter } from '@utils/file'
 import { getProductVersion } from '@utils/contentVersions'
 import { errorResultToString } from '@utils/result'

app/api/content/[productSlug]/nav-data/[version]/[...section]/route.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import {
 	expect,
 	describe,

app/api/content/[productSlug]/nav-data/[version]/[...section]/route.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { readFile, parseJson } from '@utils/file'
 import { getProductVersion } from '@utils/contentVersions'
 import { errorResultToString } from '@utils/result'

app/api/content/[productSlug]/redirects/route.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { expect, test, vi } from 'vitest'
 import { GET } from './route'
 

app/api/content/[productSlug]/redirects/route.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { getProductVersion } from '@utils/contentVersions'
 import { readFile, parseJsonc } from '@utils/file'
 import { errorResultToString } from '@utils/result'

app/api/content/[productSlug]/version-metadata/route.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import {
 	expect,
 	describe,

app/api/content/[productSlug]/version-metadata/route.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { getProductVersionMetadata } from '@utils/contentVersions'
 import { errorResultToString } from '@utils/result'
 

app/layout.tsx

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import React from 'react'
 
 // eslint-disable-next-line no-restricted-exports

app/page.tsx

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 /** Add your relevant code here for the issue to reproduce */
 // eslint-disable-next-line no-restricted-exports
 export default function Home() {

app/utils/allDocsPaths.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { expect, test, vi } from 'vitest'
 import { getDocsPaths } from './allDocsPaths'
 import docsPathsMock from '../../__fixtures__/docsPathsAllVersionsMock.json'

app/utils/allDocsPaths.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { Ok, Err, errorResultToString } from '@utils/result'
 import docsPathsAllVersions from '@api/docsPathsAllVersions.json'
 import { getProductVersion } from './contentVersions'

app/utils/contentVersions.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import versionMetadata from '@api/versionMetadata.json'
 import { Ok, Err } from '@utils/result'
 

app/utils/file.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import grayMatter from 'gray-matter'
 import { parse as jsoncParse } from 'jsonc-parser'
 

app/utils/findDocVersions.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import docsPathsAllVersions from '@api/docsPathsAllVersions.json'
 
 /**

app/utils/productConfig.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import semver from 'semver'
 
 /**

app/utils/result.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 // The result type is used to represent the result of an operation that can fail. It is a common pattern in Rust and other languages. This pattern is useful for handling errors in a more structured way and avoiding exceptions. Because any error state is wrapped in Err and any success state is wrapped in Ok. See "app/utils/file.ts" for an example of how this is used.
 
 export type Result<T, E = undefined> =

app/utils/utils.test.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { expect, test, vi, afterEach, beforeEach } from 'vitest'
 import { vol } from 'memfs'
 import {

docker-compose.yaml

@@ -1,3 +1,6 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: BUSL-1.1
+
 services:
   dev-portal:
     image: 'hashicorp/dev-portal:latest'

eslint.config.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import globals from 'globals'
 import pluginJs from '@eslint/js'
 import tseslint from 'typescript-eslint'

next.config.js

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 /** @type {import("next").NextConfig} */
 const nextConfig = {
 	reactStrictMode: true,

scripts/add-version-to-nav-data.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import fs from 'node:fs/promises'
 import { PRODUCT_CONFIG } from '../app/utils/productConfig.mjs'
 import semver from 'semver'

scripts/algolia/batch-post-records/batch-post-records-to-algolia.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import fs from 'fs'
 import algoliasearch from 'algoliasearch'
 

scripts/algolia/batch-post-records/batch-post-records-to-algolia.test.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { describe, it, expect, vi, afterEach } from 'vitest'
 import { batchPostRecords } from './batch-post-records-to-algolia.mjs'
 import algoliasearch from 'algoliasearch'

scripts/algolia/batch-post-records/index.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { batchPostRecords } from './batch-post-records-to-algolia.mjs'
 import path from 'path'
 

scripts/algolia/build-algolia-records.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import path from 'path'
 import grayMatter from 'gray-matter'
 import { createAlgoliaRecordObject } from './transform-mdx-to-algolia-record/create-records.mjs'

scripts/algolia/convert-mdx-to-json/index.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import path from 'path'
 import { readdir } from 'node:fs/promises'
 import { getLatestVersion } from '../../utils/file-path/latest-version/index.mjs'

scripts/algolia/convert-mdx-to-json/index.test.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { describe, test, expect, vi } from 'vitest'
 import path from 'path'
 import { readdir } from 'node:fs/promises'

scripts/algolia/transform-mdx-to-algolia-record/code-list-items/collect-code-list-items.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import remark from 'remark'
 import visit from 'unist-util-visit'
 import is from 'unist-util-is'

scripts/algolia/transform-mdx-to-algolia-record/code-list-items/collect-code-list-items.test.mjs

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
 import { describe, test, expect } from 'vitest'
 import { collectCodeListItems } from './collect-code-list-items.mjs'