Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README for VaGovBuildTrigger Module #19903

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion docroot/modules/custom/va_gov_build_trigger/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# VaGovBuildTrigger
VA.gov Build Trigger Module.

The VaGovBuildTrigger module is a crucial component in the VA.gov content publishing workflow.

## 1. Purpose

- It's responsible for triggering the build process that publishes content from the Drupal CMS to the public-facing VA.gov website

## 2. Architecture Context

- VA.gov is a static site hosted on S3 with HTML, CSS, JavaScript and images
- The CMS is built on Drupal 10 and acts as both a content management tool and an API server
- Content builds are executed through the content-build project which pulls content via GraphQL and other APIs

## 3. Importance

- It's a key part of the decoupled architecture, bridging the gap between content creation in the CMS and publication to VA.gov
- Enables the continuous integration process where content changes trigger new builds
- Works with GitHub Actions to initiate builds that generate static assets which get deployed to S3

## 4. Integration Points

- Interfaces with the content-build repository
- Works alongside other modules like va_gov_content_release to manage the content deployment pipeline
- Coordinates with both development environments and production systems (prod.cms.va.gov)

The module is essential for maintaining the automated, decoupled publishing workflow that powers VA.gov's content management system.

```mermaid
graph LR
CMS[VA.gov CMS<br/>Drupal 10] -->|GraphQL API| CB[content-build]
CMS -->|JSON API| CB
CB -->|Triggers| GHA[GitHub Actions]
GHA -->|Builds static files| Build[HTML/CSS/JS/images]
Build -->|Deploys to| S3[Amazon S3]
S3 -->|Serves| Web["<a href='https://www.va.gov'>www.va.gov</a>"]
```
Loading