Skip to content

chore(ci): stop publishing docs from task-refactor#696

Merged
rsarika merged 3 commits into
webex:task-refactorfrom
rsarika:stop-gh-pages-task-refactor
Jun 12, 2026
Merged

chore(ci): stop publishing docs from task-refactor#696
rsarika merged 3 commits into
webex:task-refactorfrom
rsarika:stop-gh-pages-task-refactor

Conversation

@rsarika

@rsarika rsarika commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

COMPLETES #< INSERT LINK TO ISSUE >

This pull request addresses

The task-refactor branch is currently included in the deploy workflow, and its documentation publish job force-pushes updates to the documentation branch. That branch is used for the repository’s GitHub Pages site and sample app content, so changes from task-refactor can unintentionally update docs/pages output even though we still want SDK publishing on the task-refactor tag path.

by making the following changes

  • Added a branch guard to .github/workflows/deploy.yml
  • Restricted the publish-documentation job to run only when github.ref_name == 'next'
  • Kept the rest of the deploy pipeline unchanged for task-refactor, including SDK/package publish behavior

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

  • The testing is done with the amplify link
  • Verified the workflow diff locally
  • Confirmed publish-documentation is now gated to next only
  • Ran git diff --check successfully

Note:

  • Repository pre-commit checks on task-refactor currently fail due to unrelated existing TypeScript/Jest issues in other packages, not because of this workflow-only change.

The GAI Coding Policy And Copyright Annotation Best Practices

  • GAI was not used (or, no additional notation is required)
  • Code was generated entirely by GAI
  • GAI was used to create a draft that was subsequently customized or modified
  • Coder created a draft manually that was non-substantively modified by GAI (e.g., refactoring was performed by GAI on manually written code)
  • Tool used for AI assistance (GitHub Copilot / Other - specify)
    • Github Copilot
    • Other - Please Specify
  • This PR is related to
    • Feature
    • Defect fix
    • Tech Debt
    • Automation

Tool used for AI assistance:

  • OpenAI Codex

Checklist before merging

  • I have not skipped any automated checks
  • All existing and new tests passed
  • I have updated the testing document
  • I have tested the functionality with amplify link

@rsarika rsarika requested a review from a team as a code owner June 11, 2026 10:25
@aws-amplify-us-east-2

Copy link
Copy Markdown

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-696.d1b38q61t1z947.amplifyapp.com

Comment thread .github/workflows/deploy.yml
@rsarika rsarika requested a review from mkesavan13 June 11, 2026 11:52

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b554229e07

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

on:
push:
branches: # Allow list of deployable tags and branches. Note that all allow-listed branches cannot include any `/` characters
- next

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Keep task-refactor package deploys running

If the goal is only to stop documentation publishes from task-refactor, removing the branch from the workflow trigger disables the entire Deploy CD workflow for that branch. In this same workflow, publish-npm still performs package versioning and deploy:npm, and publish-tag depends on it; I also checked .github/workflows and found no other workflow that publishes npm packages for task-refactor. This means pushes to task-refactor will no longer publish package prereleases/tags at all, not just skip the docs job; gate publish-documentation instead if package publishing should continue.

Useful? React with 👍 / 👎.

@rsarika rsarika added the validated Indicates that the PR is ready for actions label Jun 11, 2026
@rsarika rsarika merged commit 8c26ab3 into webex:task-refactor Jun 12, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

validated Indicates that the PR is ready for actions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants