Skip to content

fix(ci): revert TechDocs workflow to v11.1.0 to fix publish failure - #333

Merged
maximizeIT merged 1 commit into
mainfrom
fix/revert-techdocs-workflow-version
Sep 10, 2026
Merged

fix(ci): revert TechDocs workflow to v11.1.0 to fix publish failure#333
maximizeIT merged 1 commit into
mainfrom
fix/revert-techdocs-workflow-version

Conversation

@maximizeIT

@maximizeIT maximizeIT commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes the TechDocs publish failure introduced by #331's GitHub Actions bump. See failing run: https://github.com/Staffbase/plugins-client-sdk/actions/runs/34456165077/job/102802932758

Root cause (confirmed)

#331 bumped .github/workflows/techdocs.yml's reusable workflow reference from v11.1.0 to v16.0.0. That template uses Staffbase/backstage-techdocs-action@v0.2.4, which added a strict input-validation step that fails with:

storage-name, azure-account-name, and azure-account-key are required for Azure Blob Storage publishing

I confirmed via the GitHub API that this is not a template-version issue — it's an org-variable visibility gap:

$ gh api repos/Staffbase/plugins-client-sdk/actions/organization-variables
→ 5 variables visible, TECHDOCS_AZURE_ACCOUNT_NAME is NOT among them

$ gh api repos/Staffbase/cc-custom-plugin-applaunchpad/actions/organization-variables
→ TECHDOCS_AZURE_ACCOUNT_NAME IS visible

cc-custom-plugin-applaunchpad's techdocs.yml is pinned to v15.1.1, which also uses backstage-techdocs-action@v0.2.4 (identical SHA) — so pinning to that version instead would not avoid the failure. applaunchpad only succeeds because its repo has org-variable access that plugins-client-sdk currently lacks.

Fix (stopgap, not a real fix)

Reverted template_techdocs.yml back to v11.1.0, which uses the older backstage-techdocs-action@v0.2.2. That version gates the Azure publish step behind if: azure-account-name != '' and silently skips it instead of failing when the var is empty. This keeps the pipeline green, but TechDocs still won't actually publish for this repo until the underlying gap is fixed — it's very possible this has been silently no-op'ing for a while already.

All other action bumps from #331 (checkout, setup-node, create-github-app-token, semantic-release-action, yarn-lock-changes) are untouched and unaffected.

Real fix needed (not in this PR, requires org-admin access)

An org admin needs to add plugins-client-sdk to the TECHDOCS_AZURE_ACCOUNT_NAME organization variable's repository scope. Once that's done, template_techdocs.yml can be safely re-bumped to v16.0.0 (or later) and TechDocs will actually publish again.

🤖 Generated with assistance from GitHub Copilot.

@github-actions

Copy link
Copy Markdown

size-limit report 📦

Path Size
src/main.js 5.76 KB (0%)

@maximizeIT
maximizeIT force-pushed the fix/revert-techdocs-workflow-version branch from 222266b to 3ea6e54 Compare September 10, 2026 08:55
…failure

v16.0.0 uses Staffbase/backstage-techdocs-action@v0.2.4, which added
strict input validation. It fails with:
  storage-name, azure-account-name, and azure-account-key are required
  for Azure Blob Storage publishing

Confirmed via the GitHub API (organization-variables endpoint) that the
org variable TECHDOCS_AZURE_ACCOUNT_NAME is not scoped/visible to this
repo, unlike e.g. cc-custom-plugin-applaunchpad, which has it. Pinning
to a different template version (e.g. v15.1.1) would not help since
that also uses backstage-techdocs-action@v0.2.4.

v11.1.0 uses the older action v0.2.2, which gates the Azure publish
step behind an 'if azure-account-name != ***' check and skips it
silently instead of failing. This keeps the pipeline green but does not
restore actual TechDocs publishing for this repo - that requires an org
admin to scope TECHDOCS_AZURE_ACCOUNT_NAME to plugins-client-sdk.

Run: https://github.com/Staffbase/plugins-client-sdk/actions/runs/34456165077

Co-authored-by: GitHub Copilot <copilot@noreply.github.com>
@maximizeIT
maximizeIT force-pushed the fix/revert-techdocs-workflow-version branch from 3ea6e54 to b91e927 Compare September 10, 2026 08:56
@maximizeIT
maximizeIT marked this pull request as ready for review September 10, 2026 08:58
@maximizeIT
maximizeIT requested a review from a team as a code owner September 10, 2026 08:58
@maximizeIT
maximizeIT requested review from Sono304 and aksdb September 10, 2026 08:58
@maximizeIT
maximizeIT merged commit ca52c8f into main Sep 10, 2026
10 checks passed
@maximizeIT
maximizeIT deleted the fix/revert-techdocs-workflow-version branch September 10, 2026 09:06
@staffbase-actions

Copy link
Copy Markdown

🎉 This PR is included in version 3.1.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants