Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[V3] Fix docs change detection in npm CI #4091

Merged
merged 1 commit into from
Feb 19, 2025

Conversation

fbbdev
Copy link
Collaborator

@fbbdev fbbdev commented Feb 19, 2025

Runtime changes in #4066 were not picked up because a) I committed the wrong files and b) the docs path in the verify changes action is missing a segment.

This is a quick fix to get the npm package up to date.

Summary by CodeRabbit

  • Chores
    • Updated our package release workflow to improve detection of documentation changes across all subdirectories. This update streamlines quality assurance by ensuring that all documentation updates are reliably captured and verified before a package release. End users benefit from a more thoroughly vetted release process without any impact on everyday functionality.

Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

Walkthrough

The pull request updates the GitHub Actions workflow for publishing an NPM package. It specifically modifies the "Verify Changed files" step by broadening the file pattern used for documentation files. The pattern is updated from matching files at a single level to matching all files within the docs directory and its subdirectories. No changes to exported or public entities or other parts of the workflow were made.

Changes

File(s) Change Summary
.github/workflows/publish-npm.yml Updated the file pattern in the "Verify Changed files" step from v3/internal/runtime/desktop/@wailsio/runtime/docs/.* to v3/internal/runtime/desktop/@wailsio/runtime/docs/**/* to include files in all subdirectories.

Suggested reviewers

  • leanthony

Poem

I’m a rabbit with a code-filled beat,
Hoppin’ through workflows, light and fleet.
Docs now spread out far and wide,
In every nook, you can now reside.
A little change, a joyful hop,
CodeRabbit cheers—let’s never stop!
🐇✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7c134d and b611d2d.

📒 Files selected for processing (1)
  • .github/workflows/publish-npm.yml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Run Go Tests (ubuntu-latest, 1.24)
  • GitHub Check: Run Go Tests (macos-latest, 1.24)
  • GitHub Check: Run Go Tests (windows-latest, 1.24)
🔇 Additional comments (2)
.github/workflows/publish-npm.yml (2)

42-43: Improved Docs File Pattern for Recursive Matching

The updated pattern
v3/internal/runtime/desktop/@wailsio/runtime/docs/**/*.*
ensures that all documentation files—including those in nested subdirectories—are detected. This change directly addresses the issue outlined in the PR objectives regarding incomplete documentation path detection.


63-63: NPM Token Configuration Confirmation

The npm publish step now correctly references the secret via ${{ secrets.NPM_TOKEN }}. This configuration is appropriate as long as the secret is properly set up in the repository’s settings, making sure that the npm publish action has the necessary credentials.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@leaanthony leaanthony merged commit 29c0d15 into wailsapp:v3-alpha Feb 19, 2025
16 of 22 checks passed
@fbbdev fbbdev deleted the v3-alpha-bugfix/npm-ci-docs branch February 19, 2025 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants