From 047e5dee27fd6aa90e4f64dcf8daadfef3cb4e61 Mon Sep 17 00:00:00 2001 From: Kenneth Belitzky Date: Tue, 26 May 2026 12:36:59 -0300 Subject: [PATCH] docs(contribs): add description field to all contribs YAML files Add a top-level description field to every YAML file under structkit/contribs/ to provide a quick summary of what each structure generates or configures. --- structkit/contribs/ansible-playbook.yaml | 4 ++++ structkit/contribs/chef-cookbook.yaml | 4 ++++ structkit/contribs/ci-cd-pipelines.yaml | 4 ++++ structkit/contribs/cloudformation-files.yaml | 4 ++++ structkit/contribs/configs/chglog.yaml | 4 ++++ structkit/contribs/configs/codeowners.yaml | 3 +++ structkit/contribs/configs/devcontainer.yaml | 4 ++++ structkit/contribs/configs/editor-config.yaml | 4 ++++ structkit/contribs/configs/eslint.yaml | 4 ++++ structkit/contribs/configs/jshint.yaml | 4 ++++ structkit/contribs/configs/kubectl.yaml | 4 ++++ structkit/contribs/configs/prettier.yaml | 4 ++++ structkit/contribs/docker-files.yaml | 4 ++++ structkit/contribs/documentation-template.yaml | 4 ++++ structkit/contribs/git-hooks.yaml | 4 ++++ structkit/contribs/github/chatmodes/plan.yaml | 4 ++++ structkit/contribs/github/instructions/generic.yaml | 4 ++++ structkit/contribs/github/prompts/generic.yaml | 4 ++++ structkit/contribs/github/prompts/react-form.yaml | 4 ++++ structkit/contribs/github/prompts/security-api.yaml | 4 ++++ structkit/contribs/github/prompts/struct.yaml | 4 ++++ structkit/contribs/github/templates.yaml | 4 ++++ structkit/contribs/github/workflows/codeql.yaml | 4 ++++ .../contribs/github/workflows/execute-tf-workflow.yaml | 5 +++++ structkit/contribs/github/workflows/labeler.yaml | 5 +++++ structkit/contribs/github/workflows/pre-commit.yaml | 4 ++++ structkit/contribs/github/workflows/release-drafter.yaml | 5 +++++ structkit/contribs/github/workflows/run-struct.yaml | 4 ++++ structkit/contribs/github/workflows/stale.yaml | 4 ++++ structkit/contribs/helm-chart.yaml | 4 ++++ structkit/contribs/kubernetes-manifests.yaml | 5 +++++ structkit/contribs/project/custom-structures.yaml | 5 +++++ structkit/contribs/project/generic.yaml | 6 ++++++ structkit/contribs/project/go.yaml | 4 ++++ structkit/contribs/project/java.yaml | 5 +++++ structkit/contribs/project/n8n.yaml | 5 +++++ structkit/contribs/project/nodejs.yaml | 4 ++++ structkit/contribs/project/python.yaml | 5 +++++ structkit/contribs/project/ruby.yaml | 5 +++++ structkit/contribs/project/rust.yaml | 5 +++++ structkit/contribs/prompts/run-struct-trigger.yaml | 5 +++++ structkit/contribs/terraform/apps/aws-accounts.yaml | 5 +++++ structkit/contribs/terraform/apps/environments.yaml | 5 +++++ structkit/contribs/terraform/apps/generic.yaml | 5 +++++ structkit/contribs/terraform/apps/github-organization.yaml | 4 ++++ structkit/contribs/terraform/apps/init.yaml | 4 ++++ structkit/contribs/terraform/modules/generic.yaml | 5 +++++ structkit/contribs/vagrant-files.yaml | 4 ++++ 48 files changed, 208 insertions(+) diff --git a/structkit/contribs/ansible-playbook.yaml b/structkit/contribs/ansible-playbook.yaml index e81c944..adddbb4 100644 --- a/structkit/contribs/ansible-playbook.yaml +++ b/structkit/contribs/ansible-playbook.yaml @@ -1,3 +1,7 @@ +description: > + Creates an Ansible playbook scaffold with main.yml, vars.yml, tasks/main.yml, + handlers/main.yml, a templates directory, and a README.md. + files: - main.yml: content: | diff --git a/structkit/contribs/chef-cookbook.yaml b/structkit/contribs/chef-cookbook.yaml index d22c368..a8dd610 100644 --- a/structkit/contribs/chef-cookbook.yaml +++ b/structkit/contribs/chef-cookbook.yaml @@ -1,3 +1,7 @@ +description: > + Creates a Chef cookbook scaffold for configuring NGINX, including a default recipe, + node attributes, an nginx.conf.erb template, a default index.html, and a README.md. + files: - recipes/default.rb: content: | diff --git a/structkit/contribs/ci-cd-pipelines.yaml b/structkit/contribs/ci-cd-pipelines.yaml index ee9f322..e7c53e5 100644 --- a/structkit/contribs/ci-cd-pipelines.yaml +++ b/structkit/contribs/ci-cd-pipelines.yaml @@ -1,3 +1,7 @@ +description: > + Creates CI/CD pipeline configuration files for multiple platforms: GitLab CI (.gitlab-ci.yml), + Jenkins (Jenkinsfile), and GitHub Actions (ci.yml and cd.yml) with build, test, and deploy stages. + files: - .gitlab-ci.yml: content: | diff --git a/structkit/contribs/cloudformation-files.yaml b/structkit/contribs/cloudformation-files.yaml index 04e7436..62073cc 100644 --- a/structkit/contribs/cloudformation-files.yaml +++ b/structkit/contribs/cloudformation-files.yaml @@ -1,3 +1,7 @@ +description: > + Creates AWS CloudFormation files: a template.yaml defining an S3 bucket resource, + a parameters.json file, and a deploy.sh script for deploying the stack via the AWS CLI. + files: - template.yaml: content: | diff --git a/structkit/contribs/configs/chglog.yaml b/structkit/contribs/configs/chglog.yaml index 931ec35..c58a4a1 100644 --- a/structkit/contribs/configs/chglog.yaml +++ b/structkit/contribs/configs/chglog.yaml @@ -1,3 +1,7 @@ +description: > + Creates git-chglog configuration files (.chglog/config.yaml and CHANGELOG.tpl.md) + for automated changelog generation with GitHub-style commit parsing and Markdown output. + files: - .chglog/config.yaml: content: | diff --git a/structkit/contribs/configs/codeowners.yaml b/structkit/contribs/configs/codeowners.yaml index 1a36c98..be568eb 100644 --- a/structkit/contribs/configs/codeowners.yaml +++ b/structkit/contribs/configs/codeowners.yaml @@ -1,3 +1,6 @@ +description: > + Creates a CODEOWNERS file assigning all repository files to a configurable GitHub username. + files: - CODEOWNERS: | * @github_username diff --git a/structkit/contribs/configs/devcontainer.yaml b/structkit/contribs/configs/devcontainer.yaml index c5997d8..3569e5a 100644 --- a/structkit/contribs/configs/devcontainer.yaml +++ b/structkit/contribs/configs/devcontainer.yaml @@ -1,3 +1,7 @@ +description: > + Creates a VS Code dev container configuration using Python 3.12 (bullseye) with + yamlfmt and pre-commit features pre-installed. + files: - .devcontainer/devcontainer.json: content: | diff --git a/structkit/contribs/configs/editor-config.yaml b/structkit/contribs/configs/editor-config.yaml index a120c3f..5454cea 100644 --- a/structkit/contribs/configs/editor-config.yaml +++ b/structkit/contribs/configs/editor-config.yaml @@ -1,3 +1,7 @@ +description: > + Creates an .editorconfig file enforcing consistent coding style across editors: + UTF-8, LF line endings, 2-space indentation, and trailing whitespace trimming. + files: - .editorconfig: content: | diff --git a/structkit/contribs/configs/eslint.yaml b/structkit/contribs/configs/eslint.yaml index 867b3a7..d512a75 100644 --- a/structkit/contribs/configs/eslint.yaml +++ b/structkit/contribs/configs/eslint.yaml @@ -1,3 +1,7 @@ +description: > + Creates ESLint configuration files (.eslintrc.json and .eslintignore) for a + React/ES2021 project with eslint:recommended and react/recommended rules enabled. + files: - .eslintrc.json: content: | diff --git a/structkit/contribs/configs/jshint.yaml b/structkit/contribs/configs/jshint.yaml index 5caa0be..5fdd492 100644 --- a/structkit/contribs/configs/jshint.yaml +++ b/structkit/contribs/configs/jshint.yaml @@ -1,3 +1,7 @@ +description: > + Creates JSHint configuration files (.jshintrc and .jshintignore) for Node.js/ES6 + JavaScript linting, excluding node_modules and dist directories. + files: - .jshintrc: content: | diff --git a/structkit/contribs/configs/kubectl.yaml b/structkit/contribs/configs/kubectl.yaml index 5000cda..300ae1f 100644 --- a/structkit/contribs/configs/kubectl.yaml +++ b/structkit/contribs/configs/kubectl.yaml @@ -1,3 +1,7 @@ +description: > + Creates a .kuberc kubectl preferences file with a custom alias for creating namespaces + and a forced --interactive=true flag for kubectl delete commands. + files: - .kuberc: content: | diff --git a/structkit/contribs/configs/prettier.yaml b/structkit/contribs/configs/prettier.yaml index f311fb0..3c88a30 100644 --- a/structkit/contribs/configs/prettier.yaml +++ b/structkit/contribs/configs/prettier.yaml @@ -1,3 +1,7 @@ +description: > + Creates Prettier code-formatting configuration files (.prettierrc and .prettierignore) + with standard style settings: single quotes, ES5 trailing commas, 80-char print width. + files: - .prettierrc: content: | diff --git a/structkit/contribs/docker-files.yaml b/structkit/contribs/docker-files.yaml index e8113aa..079a45a 100644 --- a/structkit/contribs/docker-files.yaml +++ b/structkit/contribs/docker-files.yaml @@ -1,3 +1,7 @@ +description: > + Creates Docker configuration files: a Dockerfile (nginx-based), .dockerignore, + a docker-compose.yml with web and db (MySQL) services, and a .env file. + files: - Dockerfile: content: | diff --git a/structkit/contribs/documentation-template.yaml b/structkit/contribs/documentation-template.yaml index 6042779..c26566b 100644 --- a/structkit/contribs/documentation-template.yaml +++ b/structkit/contribs/documentation-template.yaml @@ -1,3 +1,7 @@ +description: > + Creates standard open-source project documentation files: README.md, CONTRIBUTING.md, + CODE_OF_CONDUCT.md, and LICENSE.md, all templated with a project_name variable. + files: - README.md: content: | diff --git a/structkit/contribs/git-hooks.yaml b/structkit/contribs/git-hooks.yaml index 4433ffe..8e2730d 100644 --- a/structkit/contribs/git-hooks.yaml +++ b/structkit/contribs/git-hooks.yaml @@ -1,3 +1,7 @@ +description: > + Creates executable Git hook shell scripts under .git/hooks/: pre-commit, + pre-push, and commit-msg, each with a placeholder for custom hook logic. + files: - .git/hooks/pre-commit: permissions: 755 diff --git a/structkit/contribs/github/chatmodes/plan.yaml b/structkit/contribs/github/chatmodes/plan.yaml index deb46c3..827c638 100644 --- a/structkit/contribs/github/chatmodes/plan.yaml +++ b/structkit/contribs/github/chatmodes/plan.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Copilot chat mode file (plan.chatmode.md) that configures an AI + planning assistant for generating implementation plans without making any code edits. + files: - ./github/chatmodes/plan.chatmode.md: content: | diff --git a/structkit/contribs/github/instructions/generic.yaml b/structkit/contribs/github/instructions/generic.yaml index 169cc3b..21359cf 100644 --- a/structkit/contribs/github/instructions/generic.yaml +++ b/structkit/contribs/github/instructions/generic.yaml @@ -1,3 +1,7 @@ +description: > + Creates a generic GitHub Copilot instructions file (.github/instructions/generic.instruction.md) + as a blank starter template for defining AI coding guidelines and context. + files: - .github/instructions/generic.instruction.md: skip_if_exists: true diff --git a/structkit/contribs/github/prompts/generic.yaml b/structkit/contribs/github/prompts/generic.yaml index 5bcf366..0df93e2 100644 --- a/structkit/contribs/github/prompts/generic.yaml +++ b/structkit/contribs/github/prompts/generic.yaml @@ -1,3 +1,7 @@ +description: > + Creates a generic GitHub Copilot prompt file (.github/prompts/generic.prompt.md) + as a blank starter template for defining reusable AI prompts. + files: - .github/prompts/generic.prompt.md: content: | diff --git a/structkit/contribs/github/prompts/react-form.yaml b/structkit/contribs/github/prompts/react-form.yaml index eafc061..638c99f 100644 --- a/structkit/contribs/github/prompts/react-form.yaml +++ b/structkit/contribs/github/prompts/react-form.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Copilot prompt for generating React form components using + react-hook-form (uncontrolled), yup validation schemas, and TypeScript types. + files: - .github/prompts/react-form.prompt.md: content: | diff --git a/structkit/contribs/github/prompts/security-api.yaml b/structkit/contribs/github/prompts/security-api.yaml index cb29120..71e4277 100644 --- a/structkit/contribs/github/prompts/security-api.yaml +++ b/structkit/contribs/github/prompts/security-api.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Copilot prompt for reviewing REST API security, covering + authentication, input validation, rate limiting, and security event logging. + files: - .github/prompts/security-api.prompt.md: content: | diff --git a/structkit/contribs/github/prompts/struct.yaml b/structkit/contribs/github/prompts/struct.yaml index 3772da9..28818bc 100644 --- a/structkit/contribs/github/prompts/struct.yaml +++ b/structkit/contribs/github/prompts/struct.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Copilot prompt that configures an AI assistant for generating + valid .struct.yaml files for the StructKit tool, with schema references and usage examples. + files: - .github/prompts/struct.prompt.md: content: | diff --git a/structkit/contribs/github/templates.yaml b/structkit/contribs/github/templates.yaml index 31b927a..30c9725 100644 --- a/structkit/contribs/github/templates.yaml +++ b/structkit/contribs/github/templates.yaml @@ -1,3 +1,7 @@ +description: > + Creates GitHub PR templates (bug fix, feature request, general PR) under + .github/PULL_REQUEST_TEMPLATE/ and an issue template under .github/ISSUE_TEMPLATE/. + files: - .github/PULL_REQUEST_TEMPLATE/bug_fix_template.md: content: | diff --git a/structkit/contribs/github/workflows/codeql.yaml b/structkit/contribs/github/workflows/codeql.yaml index 102d2f2..bf15e87 100644 --- a/structkit/contribs/github/workflows/codeql.yaml +++ b/structkit/contribs/github/workflows/codeql.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Actions CodeQL analysis workflow (z-codeql.yaml) for JavaScript + security scanning, triggered on push/PR to default branches and on a weekly schedule. + files: - .github/workflows/z-codeql.yaml: content: | # yaml diff --git a/structkit/contribs/github/workflows/execute-tf-workflow.yaml b/structkit/contribs/github/workflows/execute-tf-workflow.yaml index 4892962..3984dc7 100644 --- a/structkit/contribs/github/workflows/execute-tf-workflow.yaml +++ b/structkit/contribs/github/workflows/execute-tf-workflow.yaml @@ -1,3 +1,8 @@ +description: > + Creates a GitHub Actions workflow for running Terraform plan on PRs and apply on pushes + to main, scoped to a specific app path under .devops/apps/. Uses variables for app name, + working directory path, and GitHub token. + files: - .github/workflows/execute-tf-{{@ app_name | slugify @}}.yaml: content: | diff --git a/structkit/contribs/github/workflows/labeler.yaml b/structkit/contribs/github/workflows/labeler.yaml index 811f74e..d404ba8 100644 --- a/structkit/contribs/github/workflows/labeler.yaml +++ b/structkit/contribs/github/workflows/labeler.yaml @@ -1,3 +1,8 @@ +description: > + Creates a GitHub Actions labeler workflow (labeler.yaml) and a labeler config + (.github/labeler.yml) that auto-assigns PR labels based on changed file paths + and branch name patterns (feature, bug, docs, release). + files: - .github/labeler.yml: content: | diff --git a/structkit/contribs/github/workflows/pre-commit.yaml b/structkit/contribs/github/workflows/pre-commit.yaml index 2c884a7..0dd15c7 100644 --- a/structkit/contribs/github/workflows/pre-commit.yaml +++ b/structkit/contribs/github/workflows/pre-commit.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Actions pre-commit workflow (z-pre-commit.yaml) and a + .pre-commit-config.yaml with check-yaml, end-of-file-fixer, and trailing-whitespace hooks. + files: - .github/workflows/z-pre-commit.yaml: content: | diff --git a/structkit/contribs/github/workflows/release-drafter.yaml b/structkit/contribs/github/workflows/release-drafter.yaml index ba6dcda..1a88251 100644 --- a/structkit/contribs/github/workflows/release-drafter.yaml +++ b/structkit/contribs/github/workflows/release-drafter.yaml @@ -1,3 +1,8 @@ +description: > + Creates a release drafter workflow (z-release-drafter.yaml), a major tagging workflow + (z-major-tagging.yaml), and a release-drafter.yml config with feature/bugfix/patch + label categories and semantic versioning resolution. + files: - .github/workflows/z-release-drafter.yaml: content: | diff --git a/structkit/contribs/github/workflows/run-struct.yaml b/structkit/contribs/github/workflows/run-struct.yaml index 341bbcb..798b32d 100644 --- a/structkit/contribs/github/workflows/run-struct.yaml +++ b/structkit/contribs/github/workflows/run-struct.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Actions workflow (run-struct.yaml) that can be manually triggered + via workflow_dispatch to run struct file generation, plus a starter .struct.yaml file. + files: - .github/workflows/run-struct.yaml: skip_if_exists: true diff --git a/structkit/contribs/github/workflows/stale.yaml b/structkit/contribs/github/workflows/stale.yaml index 2173d11..63476ff 100644 --- a/structkit/contribs/github/workflows/stale.yaml +++ b/structkit/contribs/github/workflows/stale.yaml @@ -1,3 +1,7 @@ +description: > + Creates a GitHub Actions workflow (stale.yaml) that runs daily on a cron schedule + to mark inactive issues and pull requests as stale with configurable messages. + files: - .github/workflows/stale.yaml: content: | diff --git a/structkit/contribs/helm-chart.yaml b/structkit/contribs/helm-chart.yaml index 5d10370..dda6908 100644 --- a/structkit/contribs/helm-chart.yaml +++ b/structkit/contribs/helm-chart.yaml @@ -1,3 +1,7 @@ +description: > + Creates a complete Helm chart scaffold including Chart.yaml, values.yaml, + Deployment/Service/Ingress templates, a helpers partial, and .helmignore. + files: - Chart.yaml: content: | diff --git a/structkit/contribs/kubernetes-manifests.yaml b/structkit/contribs/kubernetes-manifests.yaml index 62d4e51..a7e3c69 100644 --- a/structkit/contribs/kubernetes-manifests.yaml +++ b/structkit/contribs/kubernetes-manifests.yaml @@ -1,3 +1,8 @@ +description: > + Creates Kubernetes manifest files for deploying a containerised application: + Deployment, Service, Ingress, ConfigMap, Secret, and README.md. + Uses variables for app name, deployment name, and Docker image details. + files: - deployment.yaml: content: | diff --git a/structkit/contribs/project/custom-structures.yaml b/structkit/contribs/project/custom-structures.yaml index 422e00d..d5799d0 100644 --- a/structkit/contribs/project/custom-structures.yaml +++ b/structkit/contribs/project/custom-structures.yaml @@ -1,3 +1,8 @@ +description: > + Creates the scaffolding for a custom StructKit structures repository: README.md, + custom-mappings.yaml, a structures/ directory, and common configs via sub-structures + (devcontainer, editor-config, prettier, run-struct, release-drafter, pre-commit). + files: - README.md: content: | diff --git a/structkit/contribs/project/generic.yaml b/structkit/contribs/project/generic.yaml index 0e1863e..6776358 100644 --- a/structkit/contribs/project/generic.yaml +++ b/structkit/contribs/project/generic.yaml @@ -1,3 +1,9 @@ +description: > + Creates a comprehensive generic project scaffold with standard directory structure + (.config, .build, src, test, doc, tools, dep), common config files (.editorconfig, + .gitignore, Dockerfile, docker-compose.yml), GitHub community files, and Terraform + environment apps (prod, stage, qa, dev, init). + files: - .config/REMOVE_ME.md: content: | diff --git a/structkit/contribs/project/go.yaml b/structkit/contribs/project/go.yaml index 8c091bd..30e6ab3 100644 --- a/structkit/contribs/project/go.yaml +++ b/structkit/contribs/project/go.yaml @@ -1,3 +1,7 @@ +description: > + Creates a Go project scaffold with standard directory layout (cmd, pkg, internal, api, test), + main.go entry point, .editorconfig, .gitignore, README.md, and Apache 2.0 LICENSE. + files: - .editorconfig: content: | diff --git a/structkit/contribs/project/java.yaml b/structkit/contribs/project/java.yaml index 3e23caf..7667262 100644 --- a/structkit/contribs/project/java.yaml +++ b/structkit/contribs/project/java.yaml @@ -1,3 +1,8 @@ +description: > + Creates a Java Maven project scaffold with pom.xml, standard Maven directory layout + (src/main/java, src/test/java), App.java and AppTest.java starters, .editorconfig, + .gitignore, README.md, and Apache 2.0 LICENSE. + files: - .editorconfig: content: | diff --git a/structkit/contribs/project/n8n.yaml b/structkit/contribs/project/n8n.yaml index 633de23..b66eb3e 100644 --- a/structkit/contribs/project/n8n.yaml +++ b/structkit/contribs/project/n8n.yaml @@ -1,3 +1,8 @@ +description: > + Creates a self-hosted n8n workflow automation setup with docker-compose.yaml + (n8n container + Traefik reverse proxy with automatic HTTPS), .env configuration, + and a local-files/ directory. Uses variables for domain, subdomain, timezone, and SSL email. + files: - .gitignore: content: | diff --git a/structkit/contribs/project/nodejs.yaml b/structkit/contribs/project/nodejs.yaml index e6f374f..3db89d9 100644 --- a/structkit/contribs/project/nodejs.yaml +++ b/structkit/contribs/project/nodejs.yaml @@ -1,3 +1,7 @@ +description: > + Creates a Node.js project scaffold with package.json, src/index.js and utils.js, + public/index.html, a test starter, .editorconfig, .gitignore, README.md, and Apache 2.0 LICENSE. + files: - .editorconfig: content: | diff --git a/structkit/contribs/project/python.yaml b/structkit/contribs/project/python.yaml index 38937fc..95de120 100644 --- a/structkit/contribs/project/python.yaml +++ b/structkit/contribs/project/python.yaml @@ -1,3 +1,8 @@ +description: > + Creates a Python project scaffold with setup.py, setup.cfg, pyproject.toml, + Makefile (with venv management), requirements.txt, src and tests directories + with starter modules, .editorconfig, .gitignore, and Apache 2.0 LICENSE. + files: - .editorconfig: content: | diff --git a/structkit/contribs/project/ruby.yaml b/structkit/contribs/project/ruby.yaml index 4e5f440..1085332 100644 --- a/structkit/contribs/project/ruby.yaml +++ b/structkit/contribs/project/ruby.yaml @@ -1,3 +1,8 @@ +description: > + Creates a Ruby project scaffold with .rubocop.yml, RSpec test structure (spec/), + lib directory with versioned module and main class, bin/console and bin/setup scripts, + .editorconfig, .gitignore, README.md, and Apache 2.0 LICENSE. + files: - .editorconfig: content: | diff --git a/structkit/contribs/project/rust.yaml b/structkit/contribs/project/rust.yaml index 5d118bc..4f233d2 100644 --- a/structkit/contribs/project/rust.yaml +++ b/structkit/contribs/project/rust.yaml @@ -1,3 +1,8 @@ +description: > + Creates a Rust project scaffold with Cargo.toml, src/main.rs and lib.rs, module files, + integration tests, benchmarks, .cargo/config for cross-compilation, .editorconfig, + .gitignore, README.md, and Apache 2.0 LICENSE. + files: - .editorconfig: content: | diff --git a/structkit/contribs/prompts/run-struct-trigger.yaml b/structkit/contribs/prompts/run-struct-trigger.yaml index 8852c7e..0dba9ab 100644 --- a/structkit/contribs/prompts/run-struct-trigger.yaml +++ b/structkit/contribs/prompts/run-struct-trigger.yaml @@ -1,3 +1,8 @@ +description: > + Creates an AI agent prompt file that instructs the assistant to query GitHub for + repositories matching a given topic in a specified organization, then trigger the + run-struct workflow on each of them. + files: - run-struct-trigger.md: content: | diff --git a/structkit/contribs/terraform/apps/aws-accounts.yaml b/structkit/contribs/terraform/apps/aws-accounts.yaml index 38097e7..e71c0b8 100644 --- a/structkit/contribs/terraform/apps/aws-accounts.yaml +++ b/structkit/contribs/terraform/apps/aws-accounts.yaml @@ -1,3 +1,8 @@ +description: > + Creates Terraform app directories for nonprod and prod AWS accounts under + .devops/apps/accounts/, each using the generic app structure with a remote backend, + plus execute-tf-workflow GitHub Actions workflows for each account. + folders: - .devops/apps/accounts/nonprod: struct: terraform/apps/generic diff --git a/structkit/contribs/terraform/apps/environments.yaml b/structkit/contribs/terraform/apps/environments.yaml index 233d712..2f8106c 100644 --- a/structkit/contribs/terraform/apps/environments.yaml +++ b/structkit/contribs/terraform/apps/environments.yaml @@ -1,3 +1,8 @@ +description: > + Creates Terraform app directories for four environments (dev, qa, stage, prod) under + .devops/apps/environments/, using the generic app structure with a remote backend, + plus execute-tf-workflow GitHub Actions workflows for each environment. + folders: - .devops/apps/environments/dev: struct: terraform/apps/generic diff --git a/structkit/contribs/terraform/apps/generic.yaml b/structkit/contribs/terraform/apps/generic.yaml index a4d712d..596ac27 100644 --- a/structkit/contribs/terraform/apps/generic.yaml +++ b/structkit/contribs/terraform/apps/generic.yaml @@ -1,3 +1,8 @@ +description: > + Creates a generic Terraform app scaffold with main.tf, variables.tf, outputs.tf, + providers.tf (with a remote backend on app.terraform.io), and README.md. + Uses variables for the remote backend organization and workspace names. + files: - main.tf: content: | diff --git a/structkit/contribs/terraform/apps/github-organization.yaml b/structkit/contribs/terraform/apps/github-organization.yaml index 6d35233..ff900e0 100644 --- a/structkit/contribs/terraform/apps/github-organization.yaml +++ b/structkit/contribs/terraform/apps/github-organization.yaml @@ -1,3 +1,7 @@ +description: > + Creates Terraform files for managing a GitHub organization: providers.tf with the + GitHub provider and a remote backend, plus main.tf, variables.tf, outputs.tf, and README.md. + files: - providers.yaml: content: | diff --git a/structkit/contribs/terraform/apps/init.yaml b/structkit/contribs/terraform/apps/init.yaml index 716a2e3..e4ed677 100644 --- a/structkit/contribs/terraform/apps/init.yaml +++ b/structkit/contribs/terraform/apps/init.yaml @@ -1,3 +1,7 @@ +description: > + Creates a Terraform init app directory under .devops/apps/init/ using the generic + app structure with a remote backend, plus an execute-tf-workflow GitHub Actions workflow. + folders: - .devops/apps/init: struct: terraform/apps/generic diff --git a/structkit/contribs/terraform/modules/generic.yaml b/structkit/contribs/terraform/modules/generic.yaml index 3648eb1..76f8fe5 100644 --- a/structkit/contribs/terraform/modules/generic.yaml +++ b/structkit/contribs/terraform/modules/generic.yaml @@ -1,3 +1,8 @@ +description: > + Creates a generic Terraform module scaffold with main.tf (EC2 instance example), + variables.tf, outputs.tf, versions.tf (with AWS and Datadog providers auto-versioned), + and README.md. Uses a module_name variable for documentation templating. + files: - main.tf: content: | diff --git a/structkit/contribs/vagrant-files.yaml b/structkit/contribs/vagrant-files.yaml index a29f20e..e1e9de7 100644 --- a/structkit/contribs/vagrant-files.yaml +++ b/structkit/contribs/vagrant-files.yaml @@ -1,3 +1,7 @@ +description: > + Creates a Vagrant development environment with a Vagrantfile (Ubuntu bionic64), + an executable bootstrap.sh provisioning script that installs nginx, and a README.md. + files: - Vagrantfile: content: |