Skip to content

Add fast-track CI for version file updates #17429

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.

Sign up for GitHub

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

Draft
CamSoper wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add fast-track CI for version file updates #17429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
82 changes: 79 additions & 3 deletions .github/workflows/pull-request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,82 @@ permissions:
id-token: write # This is required for requesting the JWT
contents: read # This is required for actions/checkout
jobs:
detect-changes:
runs-on: ubuntu-latest
outputs:
version-files-only: ${{ steps.check.outputs.version-files-only }}
steps:
- uses: actions/checkout@v4

- uses: dorny/paths-filter@v3
id: filter
with:
filters: |
version-files:
- 'static/latest-dev-version'
- 'static/latest-version'
- 'static/esc/latest-version'
- 'static/customer-managed-workflow-agent/latest-version'
other-files:
- '**/*'
- '!static/latest-dev-version'
- '!static/latest-version'
- '!static/esc/latest-version'
- '!static/customer-managed-workflow-agent/latest-version'

- name: Check if version files only
id: check
run: |
if [[ "${{ steps.filter.outputs.version-files }}" == "true" && "${{ steps.filter.outputs.other-files }}" == "false" ]]; then
echo "version-files-only=true" >> $GITHUB_OUTPUT
else
echo "version-files-only=false" >> $GITHUB_OUTPUT
fi

fast-track-version-update:
needs: detect-changes
if: needs.detect-changes.outputs.version-files-only == 'true'
name: Fast-track version file validation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v6
with:
node-version: '24.x'

- uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.154.5'
extended: true

- name: Install dependencies
run: make ensure

- name: Validate version files
run: |
# Check for whitespace in version files
Copy link
Contributor

@cnunciato cnunciato Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My docs-ops recollection is still coming online, but I think this check is either not needed (since the hugo build will fail as it does today if latest-dev-version contains any whitespace), or we should be running it for all of these files, in which case it'd probably belong in a script, like in build-site.sh. What do you think?

for file in static/latest-dev-version static/latest-version static/esc/latest-version static/customer-managed-workflow-agent/latest-version; do
if [[ -f "$file" ]]; then
if grep -q '[[:space:]]' "$file"; then
echo "ERROR: $file contains whitespace"
exit 1
fi
echo "✓ $file is valid"
fi
done

- name: Quick Hugo build test
run: hugo --minify --quiet
env:
HUGO_ENVIRONMENT: production

buildSite:
# Only run this job for events that originate on this repository.
if: github.event.pull_request.head.repo.full_name == github.repository
needs: detect-changes
if: |
github.event.pull_request.head.repo.full_name == github.repository &&
needs.detect-changes.outputs.version-files-only == 'false'
env:
GOPATH: ${{ github.workspace }}/go
name: Install deps and build site
Expand Down Expand Up @@ -70,10 +143,13 @@ jobs:
name: origin-bucket-metadata
path: origin-bucket-metadata.json
notify:
if: (startsWith(github.ref, 'refs/heads/release/') || github.ref == 'refs/heads/master' || (github.event_name == 'pull_request' && github.event.pull_request.user.login == 'pulumi-bot')) && failure()
if: |
always() &&
(startsWith(github.ref, 'refs/heads/release/') || github.ref == 'refs/heads/master' || (github.event_name == 'pull_request' && github.event.pull_request.user.login == 'pulumi-bot')) &&
(needs.buildSite.result == 'failure' || needs.fast-track-version-update.result == 'failure')
name: Send slack notification
runs-on: ubuntu-latest
needs: [buildSite]
needs: [detect-changes, fast-track-version-update, buildSite]
steps:
- name: Fetch secrets from ESC
id: esc-secrets
Expand Down
26 changes: 22 additions & 4 deletions BUILD-AND-DEPLOY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1002,7 +1002,25 @@ The repository uses 24 GitHub Actions workflows organized into categories. All w

**Jobs:**

1. **buildSite**
1. **detect-changes**
- Analyze changed files to determine if PR contains only version file updates
- Output: `version-files-only` flag (true/false)

1. **fast-track-version-update** (conditional)
- Runs only when PR contains only version file changes:
- `static/latest-dev-version`
- `static/latest-version`
- `static/esc/latest-version`
- `static/customer-managed-workflow-agent/latest-version`
- Performs lightweight validation:
- Install dependencies (`make ensure`)
- Validate no whitespace in version files
- Quick Hugo build test (`hugo --minify --quiet`)
- **Duration:** ~2-3 minutes (vs 10-15 minutes for full build)
- **Why:** Version files are updated multiple times daily via automation. Full CI/CD (site build, Cypress tests, deployment) is unnecessary for these simple text file changes.

1. **buildSite** (conditional)
- Runs only when PR contains changes beyond version files
- Check if PR is from fork (skip deployment if true)
- Build site in preview mode
- Create PR-specific S3 bucket:
Expand All @@ -1023,8 +1041,8 @@ The repository uses 24 GitHub Actions workflows organized into categories. All w

- Archive test results and metadata

2. **notify**
- Slack alert on failure
1. **notify**
- Slack alert on failure from either fast-track or full build

**Preview Lifecycle:**

Expand Down Expand Up @@ -1366,7 +1384,7 @@ These workflows support repository maintenance, automation, and developer experi
|----------|---------|-------------|----------|---------|
| build-and-deploy | Push to master, Scheduled | Production | 8-12 min | Production deployment |
| testing-build-and-deploy | Push to master, Manual | Testing | 8-12 min | Testing deployment |
| pull-request | PRs to master | Testing | 10-15 min | PR validation & preview |
| pull-request | PRs to master | Testing | 2-3 min (version files only), 10-15 min (full build) | PR validation & preview |
| pr-closed | PR closed | Testing | <1 min | Cleanup preview resources |
| pulumi-cli | Repository dispatch | N/A | 5-10 min | Auto-generate CLI docs |
| esc-cli | Repository dispatch | N/A | 3-5 min | Auto-generate ESC docs |
Expand Down
Loading