Create doc site

.github/workflows/deploy-pages.yml

@@ -0,0 +1,47 @@
+name: Deploy GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - run: npm ci
+        working-directory: docs-site
+
+      - run: npm run build
+        working-directory: docs-site
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs-site/dist
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/deploy-pages@v4

README.md

@@ -30,15 +30,15 @@ plugin "aws-meta" {
 
 |Name|Description|Severity|Enabled By Default|Link|
 | --- | --- | --- | --- | --- |
-|aws_meta_hardcoded|Validates that there are no hardcoded AWS regions or partitions in ARN values across all resource types|WARNING|✅|[docs](docs/rules.md#aws_meta_hardcoded)|
-|aws_iam_role_policy_hardcoded_region|Validates that there are no hardcoded AWS regions in IAM role policy documents|WARNING|❌|[docs](docs/rules.md#aws_iam_role_policy_hardcoded_region)|
-|aws_iam_role_policy_hardcoded_partition|Validates that there are no hardcoded AWS partitions in IAM role policy documents|WARNING|❌|[docs](docs/rules.md#aws_iam_role_policy_hardcoded_partition)|
-|aws_iam_policy_hardcoded_region|Validates that there are no hardcoded AWS regions in IAM policy documents|WARNING|❌|[docs](docs/rules.md#aws_iam_policy_hardcoded_region)|
-|aws_iam_policy_hardcoded_partition|Validates that there are no hardcoded AWS partitions in IAM policy documents|WARNING|❌|[docs](docs/rules.md#aws_iam_policy_hardcoded_partition)|
-|aws_provider_hardcoded_region|Validates that there are no hardcoded AWS regions in provider configuration|WARNING|❌|[docs](docs/rules.md#aws_provider_hardcoded_region)|
-|aws_service_principal_hardcoded|Validates that service principals don't use hardcoded DNS suffixes (e.g., amazonaws.com)|WARNING|❌|[docs](docs/rules.md#aws_service_principal_hardcoded)|
-|aws_service_principal_dns_suffix|Validates that service principals don't use dns_suffix interpolation|WARNING|✅|[docs](docs/rules.md#aws_service_principal_dns_suffix)|
-
-For detailed examples and usage information, see the [Rule Details documentation](docs/rules.md).
+|aws_meta_hardcoded|Validates that there are no hardcoded AWS regions or partitions in ARN values across all resource types|WARNING|✅|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_meta_hardcoded)|
+|aws_iam_role_policy_hardcoded_region|Validates that there are no hardcoded AWS regions in IAM role policy documents|WARNING|❌|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_iam_role_policy_hardcoded_region)|
+|aws_iam_role_policy_hardcoded_partition|Validates that there are no hardcoded AWS partitions in IAM role policy documents|WARNING|❌|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_iam_role_policy_hardcoded_partition)|
+|aws_iam_policy_hardcoded_region|Validates that there are no hardcoded AWS regions in IAM policy documents|WARNING|❌|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_iam_policy_hardcoded_region)|
+|aws_iam_policy_hardcoded_partition|Validates that there are no hardcoded AWS partitions in IAM policy documents|WARNING|❌|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_iam_policy_hardcoded_partition)|
+|aws_provider_hardcoded_region|Validates that there are no hardcoded AWS regions in provider configuration|WARNING|❌|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_provider_hardcoded_region)|
+|aws_service_principal_hardcoded|Validates that service principals don't use hardcoded DNS suffixes (e.g., amazonaws.com)|WARNING|❌|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_service_principal_hardcoded)|
+|aws_service_principal_dns_suffix|Validates that service principals don't use dns_suffix interpolation|WARNING|✅|[docs](https://myerscode.github.io/tflint-ruleset-aws-meta/rules/aws_service_principal_dns_suffix)|
+
+For detailed examples and usage information, see the [documentation site](https://myerscode.github.io/tflint-ruleset-aws-meta/).
 
 

docs-site/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

docs-site/astro.config.mjs

@@ -0,0 +1,31 @@
+// @ts-check
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+// https://astro.build/config
+export default defineConfig({
+  site: 'https://myerscode.github.io',
+  base: '/tflint-ruleset-aws-meta/',
+
+  integrations: [
+    starlight({
+      title: 'TFLint AWS Meta Ruleset',
+      description: 'Documentation for the tflint-ruleset-aws-meta project',
+      sidebar: [
+        {
+          label: 'Overview',
+          items: [
+            { label: 'Introduction', link: '/' },
+            { label: 'Installation', link: '/installation' },
+            { label: 'Configuration', link: '/configuration' },
+            // { label: 'Contributing', link: '/contributing' },
+          ],
+        },
+        {
+          label: 'Rules',
+          autogenerate: { directory: 'rules' },
+        },
+      ],
+    }),
+  ],
+});