webgrip/application-template

Fork 0

[PR #3] [MERGED] feat: comprehensive application template with automated sync, architectural documentation, and production-ready infrastructure #28

New issue

Closed

opened 2026-06-08 08:27:25 +00:00 by ryangr0 · 0 comments

ryangr0 commented

2026-06-08 08:27:25 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/webgrip/application-template/pull/3
Author: @Copilot
Created: 8/30/2025
Status: ✅ Merged
Merged: 9/3/2025
Merged by: @Ryangr0

Base: main ← Head: copilot/fix-2

📝 Commits (10+)

984daf6 Initial plan
a92691d feat: implement template file synchronization workflow
069980e feat: update template sync to use 'application' topic and semantic commits
8501f61 feat: implement comprehensive ACT testing infrastructure for GitHub workflows
5ab7808 feat: initialize npm project with integrated scripts and Node.js tooling
f69acd0 feat: implement Docker-based ACT with locally built image for GitHub Actions testing
6586f8e refactor: refactored a lot, pulled changes from downstream applications that I like into here
a5f8218 refactor: made some other small changes from downstream
300922d refactor: crossing ts
05b4122 fix: resolve Docker image naming, workflow syntax, and Node.js version consistency issues

📊 Changes

39 files changed (+1436 additions, -235 deletions)

View changed files

📝 .dockerignore (+4 -0)
📝 .env.example (+2 -2)
📝 .github/copilot-instructions.md (+1 -4)
📝 .github/pull_request_template.md (+32 -37)
📝 .github/workflows/on_source_change.yml (+6 -0)
➕ .github/workflows/on_synced_files_change.yml (+87 -0)
➖ .github/workflows/on_workflow_files_change.yml (+0 -70)
📝 .gitignore (+13 -0)
📝 .vscode/settings.json (+1 -1)
📝 AGENTS.md (+1 -9)
📝 Makefile (+280 -72)
📝 README.md (+71 -6)
📝 docker-compose.yml (+6 -2)
➕ docs/adrs/0001-framework-docker-for-local-development.md (+106 -0)
➕ docs/adrs/0002-framework-kubernetes-as-deployment-platform.md (+124 -0)
➕ docs/adrs/0003-framework-helm-for-deployment.md (+122 -0)
📝 docs/techdocs/mkdocs.yml (+2 -1)
➕ docs/techdocs/template-sync.md (+139 -0)
➕ ops/docker/application/.gitkeep (+0 -0)
➕ ops/docker/application/Dockerfile (+34 -0)

...and 19 more files

📄 Description

This PR provides a complete application template foundation with automated template file synchronization, comprehensive architectural documentation, and production-ready infrastructure tooling.

Key Features

Template Synchronization System

Topic-based targeting: Repositories with the application topic automatically receive updates
Safe pull request workflow: Changes are proposed via PRs for review, not pushed directly
Selective file sync: Only syncs specific template files (workflows, config files, dev tools)
Semantic commit style: Uses conventional commit format with feat/sync-template-files-* branch naming
Clear conflict handling: Template files take precedence with transparent documentation

Comprehensive Infrastructure

Docker development environment: Multi-service setup with application, PostgreSQL, Redis, and MariaDB
Kubernetes deployment ready: Production deployment patterns with auto-scaling and rolling updates
Helm packaging: Comprehensive chart structure with templating and dependency management
Secrets management: Age/SOPS encrypted secrets workflow with proper key handling
Security scanning: Static analysis tools integration (kube-score, kube-linter, kubesec)

Developer Experience

Comprehensive Makefile: 50+ targets for Docker, Helm, Kubernetes, secrets, and development workflows
Node.js integration: Modern package.json with script bridges to existing tooling
Version management: Node.js version consistency with .nvmrc and Volta configuration
Editor configuration: Consistent development environment with EditorConfig and VSCode settings

Architectural Documentation

Includes comprehensive Architecture Decision Records (ADRs) documenting key technology choices:

ADR-001: Docker for Local Development - Documents containerized development approach for consistency and reproducibility
ADR-002: Kubernetes as Deployment Platform - Documents production deployment strategy with comprehensive feature set
ADR-003: Helm for Deployment - Documents packaging and deployment automation choices

Usage

Template Sync

Add the application topic to any application repository
When template files are updated, the workflow automatically creates PRs in target repositories
Repository maintainers review and merge changes as appropriate

Development Workflow

# Start development environment
make start

# Initialize Helm charts
make init-helm

# Encrypt secrets
make secrets:encrypt SECRETS_DIR=./ops/secrets/staging

# NPM integration
npm run docker:up
npm run helm:init
npm run secrets:encrypt

This template eliminates the need to manually copy files or rebuild repositories while providing robust infrastructure patterns and comprehensive documentation for production applications.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/webgrip/application-template/pull/3 **Author:** [@Copilot](https://github.com/apps/copilot-swe-agent) **Created:** 8/30/2025 **Status:** ✅ Merged **Merged:** 9/3/2025 **Merged by:** [@Ryangr0](https://github.com/Ryangr0) **Base:** `main` ← **Head:** `copilot/fix-2` --- ### 📝 Commits (10+) - [`984daf6`](https://github.com/webgrip/application-template/commit/984daf613f45eec6fa2a60560706c20289017d4d) Initial plan - [`a92691d`](https://github.com/webgrip/application-template/commit/a92691df8612de747a84776875301afb5e26b9ba) feat: implement template file synchronization workflow - [`069980e`](https://github.com/webgrip/application-template/commit/069980e1dd2677607c1a33c5754be8b705d754d8) feat: update template sync to use 'application' topic and semantic commits - [`8501f61`](https://github.com/webgrip/application-template/commit/8501f6129d23f7e4743fc6275ea958304bf9f3a9) feat: implement comprehensive ACT testing infrastructure for GitHub workflows - [`5ab7808`](https://github.com/webgrip/application-template/commit/5ab7808d223aead53089a87d1ca93bf3080cb9fa) feat: initialize npm project with integrated scripts and Node.js tooling - [`f69acd0`](https://github.com/webgrip/application-template/commit/f69acd00f9d6845eb4ee650deaba492e0b89edce) feat: implement Docker-based ACT with locally built image for GitHub Actions testing - [`6586f8e`](https://github.com/webgrip/application-template/commit/6586f8e2839d47838e2b0cbc9bca73aa5bc13006) refactor: refactored a lot, pulled changes from downstream applications that I like into here - [`a5f8218`](https://github.com/webgrip/application-template/commit/a5f8218e8e49685127cf2bfa41ac0a1b9194b9ed) refactor: made some other small changes from downstream - [`300922d`](https://github.com/webgrip/application-template/commit/300922d662e5dedf566e74aabccdcab61e46f132) refactor: crossing ts - [`05b4122`](https://github.com/webgrip/application-template/commit/05b41229fb37d8d78235941e7cf67a18740aa57a) fix: resolve Docker image naming, workflow syntax, and Node.js version consistency issues ### 📊 Changes **39 files changed** (+1436 additions, -235 deletions) <details> <summary>View changed files</summary> 📝 `.dockerignore` (+4 -0) 📝 `.env.example` (+2 -2) 📝 `.github/copilot-instructions.md` (+1 -4) 📝 `.github/pull_request_template.md` (+32 -37) 📝 `.github/workflows/on_source_change.yml` (+6 -0) ➕ `.github/workflows/on_synced_files_change.yml` (+87 -0) ➖ `.github/workflows/on_workflow_files_change.yml` (+0 -70) 📝 `.gitignore` (+13 -0) 📝 `.vscode/settings.json` (+1 -1) 📝 `AGENTS.md` (+1 -9) 📝 `Makefile` (+280 -72) 📝 `README.md` (+71 -6) 📝 `docker-compose.yml` (+6 -2) ➕ `docs/adrs/0001-framework-docker-for-local-development.md` (+106 -0) ➕ `docs/adrs/0002-framework-kubernetes-as-deployment-platform.md` (+124 -0) ➕ `docs/adrs/0003-framework-helm-for-deployment.md` (+122 -0) 📝 `docs/techdocs/mkdocs.yml` (+2 -1) ➕ `docs/techdocs/template-sync.md` (+139 -0) ➕ `ops/docker/application/.gitkeep` (+0 -0) ➕ `ops/docker/application/Dockerfile` (+34 -0) _...and 19 more files_ </details> ### 📄 Description This PR provides a complete application template foundation with automated template file synchronization, comprehensive architectural documentation, and production-ready infrastructure tooling. ## Key Features ### Template Synchronization System - **Topic-based targeting**: Repositories with the `application` topic automatically receive updates - **Safe pull request workflow**: Changes are proposed via PRs for review, not pushed directly - **Selective file sync**: Only syncs specific template files (workflows, config files, dev tools) - **Semantic commit style**: Uses conventional commit format with `feat/sync-template-files-*` branch naming - **Clear conflict handling**: Template files take precedence with transparent documentation ### Comprehensive Infrastructure - **Docker development environment**: Multi-service setup with application, PostgreSQL, Redis, and MariaDB - **Kubernetes deployment ready**: Production deployment patterns with auto-scaling and rolling updates - **Helm packaging**: Comprehensive chart structure with templating and dependency management - **Secrets management**: Age/SOPS encrypted secrets workflow with proper key handling - **Security scanning**: Static analysis tools integration (kube-score, kube-linter, kubesec) ### Developer Experience - **Comprehensive Makefile**: 50+ targets for Docker, Helm, Kubernetes, secrets, and development workflows - **Node.js integration**: Modern package.json with script bridges to existing tooling - **Version management**: Node.js version consistency with .nvmrc and Volta configuration - **Editor configuration**: Consistent development environment with EditorConfig and VSCode settings ## Architectural Documentation Includes comprehensive Architecture Decision Records (ADRs) documenting key technology choices: - **ADR-001: Docker for Local Development** - Documents containerized development approach for consistency and reproducibility - **ADR-002: Kubernetes as Deployment Platform** - Documents production deployment strategy with comprehensive feature set - **ADR-003: Helm for Deployment** - Documents packaging and deployment automation choices ## Usage ### Template Sync 1. Add the `application` topic to any application repository 2. When template files are updated, the workflow automatically creates PRs in target repositories 3. Repository maintainers review and merge changes as appropriate ### Development Workflow ```bash # Start development environment make start # Initialize Helm charts make init-helm # Encrypt secrets make secrets:encrypt SECRETS_DIR=./ops/secrets/staging # NPM integration npm run docker:up npm run helm:init npm run secrets:encrypt ``` This template eliminates the need to manually copy files or rebuild repositories while providing robust infrastructure patterns and comprehensive documentation for production applications.  --- ✨ Let Copilot coding agent [set things up for you](https://github.com/webgrip/application-template/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

ryangr0

2026-06-08 08:27:25 +00:00

closed this issue
added the
pull-request
label

No labels

enhancement

pull-request

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

webgrip/application-template#28

No description provided.

Rows
Columns