Skip to content

Deployment workflow updates#6540

Open
vfalconisumo wants to merge 2 commits intomainfrom
workflow-updates-2026-04-03
Open

Deployment workflow updates#6540
vfalconisumo wants to merge 2 commits intomainfrom
workflow-updates-2026-04-03

Conversation

@vfalconisumo
Copy link
Copy Markdown
Collaborator

Purpose of this pull request

This pull request updates the production deployment workflow in two ways:

  1. Replaces the haythem/public-ip Action with an equivalent shell script. We're not sure of the how or the why, but haythem/public-ip has been returning intermittent errors which have broken pipeline runs for a few weeks.
  2. Clarifies the triggering reason sent to Jenkins, making the message more human-readable.

Risk

I've tested the new scripts in a sandbox and am confident they work. However, if the changes do introduce workflow errors, publishing docs content will be impacted.

If the workflow fails as a result of these changes, revert this PR to restore the workflow.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

  1. Runner IP replacement: Asana
  2. Triggering reason clarity: Asana

@vfalconisumo vfalconisumo requested a review from kimsauce as a code owner April 3, 2026 19:59
@cla-bot cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label Apr 3, 2026
@jpipkin1
Copy link
Copy Markdown
Collaborator

jpipkin1 commented Apr 3, 2026

@kimsauce, could you review this PR? It fixes a problem that we've been having in the deployment pipeline lately (see here).

@kimsauce
Copy link
Copy Markdown
Collaborator

kimsauce commented Apr 3, 2026

@kimsauce, could you review this PR? It fixes a problem that we've been having in the deployment pipeline lately (see here).

@jpipkin1 sure thing! Thank you for the additional background. 👍

@kimsauce
Copy link
Copy Markdown
Collaborator

kimsauce commented Apr 6, 2026

Hi @vfalconisumo , thank you for doing this! I wasn't sure how to test the changes, but this was Claude Code's advice.

Code review notes on workflow changes

Two issues in .github/workflows/job_trigger-jenkins-pipeline.yml:

1. Multiline commit messages will break GITHUB_OUTPUT

# Current — breaks if commit message has multiple lines
echo "reason=$REASON" >> $GITHUB_OUTPUT

Fix:

echo "reason<<EOF" >> $GITHUB_OUTPUT
echo "$REASON" >> $GITHUB_OUTPUT
echo "EOF" >> $GITHUB_OUTPUT

2. Commit messages with special characters will produce invalid JSON

# Current — a commit message like: Fix bug in "auth" module
# produces:  { "TRIGGER_SOURCE": "Fix bug in "auth" module" }  ← invalid JSON
-d '{ "TRIGGER_SOURCE": "${{ steps.cause.outputs.reason }}" }'

Fix using jq to safely escape the value:

-d "$(jq -n --arg src "${{ steps.cause.outputs.reason }}" '{"TRIGGER_SOURCE": $src}')"

Both issues stem from PR titles and commit messages being freeform user text that isn't sanitized before being embedded in structured formats (JSON, GITHUB_OUTPUT).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants