Skip to content

feat: upgrading client component script and including new workflow to automatically regenerate these.#1009

Open
MatthewHawkins wants to merge 4 commits into
mainfrom
808-automate-weekly-regeneration-of-client-component-docs
Open

feat: upgrading client component script and including new workflow to automatically regenerate these.#1009
MatthewHawkins wants to merge 4 commits into
mainfrom
808-automate-weekly-regeneration-of-client-component-docs

Conversation

@MatthewHawkins

Copy link
Copy Markdown
Member

…automatically regenerate these.

@MatthewHawkins MatthewHawkins linked an issue Jun 17, 2026 that may be closed by this pull request
@hyyan hyyan added the status: waiting-for-review The PR is ready. Waiting for team members to review. label Jun 18, 2026
@bbrennanbasis bbrennanbasis changed the title feat: upgrading client component script andincluding new workflow to … feat: upgrading client component script and including new workflow to automatically regenerate these. Jul 8, 2026
- Removed unused parts in client component docs (imports, br tags, etc.)
- Doesn't load a DocChip if the client component doesn't have encapsulation

@bbrennanbasis bbrennanbasis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Changes I made:

  • Removed unused parts in client component docs (imports, br tags, etc.)
  • Doesn't load a DocChip if the client component doesn't have encapsulation (I saw <DocChip chip='none' /> being loaded)

My only suggestion is to have the workflow show as a failure if create_files.js throws an error.

Comment on lines +32 to +44

- name: Commit and push regenerated docs
run: |
git config --local user.email "${{ secrets.ACTOR_EMAIL }}"
git config --local user.name "${{ secrets.ACTOR_NAME }}"

if [ -n "$(git status --porcelain docs/docs/client-components/)" ]; then
git add docs/docs/client-components/
git commit -m "chore: regenerate client component docs"
git push
else
echo "::notice::No changes in client component docs - nothing to commit"
fi

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@MatthewHawkins, don't we want to have the action shown as failed if create_files.js throws an error instead of failing silently?

@bbrennanbasis bbrennanbasis added status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond. and removed status: waiting-for-review The PR is ready. Waiting for team members to review. labels Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: waiting-for-author Review is done. Waiting for the PR author to apply changes or respond.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automate Weekly Regeneration of Client Component Docs

4 participants