Skip to content

Sync Shared Documentation workflow fails on commit messages with single quotes #333

Description

@mottych

Summary

The Sync Shared Documentation workflow can fail in its summary step when the commit message contains single quotes.

Observed behavior

After merging issue #332, the application deployment workflows passed, but Sync Shared Documentation failed in job sync-docs, step Summary with a shell parsing error caused by the merge commit message.

Example triggering message:
Merge branch 'feature/issue-332-scoped-coaching-sessions' into dev

Observed error:
unexpected EOF while looking for matching '''

Expected behavior

The workflow should safely render commit metadata in $GITHUB_STEP_SUMMARY regardless of quotes or other shell-sensitive characters in the commit message.

Likely cause

.github/workflows/sync-shared-docs.yml currently interpolates the commit message into a shell echo command without safe escaping.

Suggested direction

Update the summary step to handle commit messages safely, for example by avoiding raw shell interpolation or by writing the value through a quoting-safe mechanism.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions