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

Add publint to CI #1705

Merged
merged 2 commits into from
Mar 18, 2025
Merged

Add publint to CI #1705

merged 2 commits into from
Mar 18, 2025

Conversation

alexeyr-ci
Copy link
Collaborator

@alexeyr-ci alexeyr-ci commented Mar 4, 2025

Summary

Add additional checks to CI with publint.

Pull Request checklist

  • [ ] Add/update test to cover these changes
  • [ ] Update documentation
  • [ ] Update CHANGELOG file

This change is Reviewable

Summary by CodeRabbit

  • Chores
    • Updated the packaging and linting process to validate a pre-packaged artifact, ensuring a more reliable validation and deployment flow.
    • Enhanced module configuration and dependency management with the addition of CommonJS module type and publint dependency.
    • Refined automation scripts handling package dependencies to ensure correct dependency adjustments during the build process, including the removal of unnecessary packages.

Copy link
Contributor

coderabbitai bot commented Mar 4, 2025

Walkthrough

This PR updates the linting workflow by replacing and adding steps in the .github/workflows/lint-js-and-ruby.yml file. It also adds a "type": "commonjs" property and a "publint": "^0.3.8" dependency in package.json. Additionally, the script/convert file has been modified to adjust how package.json dependencies are managed, specifically by retaining the "knip" package and removing "publint". These changes shift the process to package-based linting and update dependency handling.

Changes

File Summary of Changes
.github/workflows/lint-js-and-ruby.yml Replaced the former "Lint package publishing" step with a new sequence that includes "Pack for attw and publint", "Lint package types", and an updated "Lint package publishing" step using packaged file commands.
package.json Added "type": "commonjs" and included "publint": "^0.3.8" in the devDependencies to support the updated linting workflow.
script/convert Adjusted gsub_file_content calls: commented out removal of "knip" and added removal of "publint", modifying how package dependencies are managed.

Sequence Diagram(s)

sequenceDiagram
    participant Repo as Repository Workflow
    participant Yarn as Yarn CLI
    participant Attw as Type Linter
    participant Publint as Publishing Linter

    Repo->>Yarn: Execute "yarn pack -f react-on-rails.tgz"
    Yarn-->>Repo: Packaged file generated
    Repo->>Yarn: Run "yarn run attw react-on-rails.tgz --profile node16 --ignore-rules cjs-only-exports-default"
    Yarn->>Attw: Perform type linting on package
    Attw-->>Repo: Return lint results
    Repo->>Yarn: Run "yarn run publint --strict react-on-rails.tgz"
    Yarn->>Publint: Perform publishing linting on package
    Publint-->>Repo: Return lint results
Loading

Possibly related PRs

Poem

I'm a little rabbit, hopping with code delight,
Through workflows and packages in the digital night.
Yarn commands tap-dance like carrots in a row,
Linting steps align, making our package glow.
In this garden of updates, may our changes forever grow!
🥕🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4070179 and e70223f.

📒 Files selected for processing (1)
  • .github/workflows/lint-js-and-ruby.yml (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/lint-js-and-ruby.yml
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: dummy-app-integration-tests (newest)
  • GitHub Check: dummy-app-integration-tests (oldest)

🪧 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.
  • @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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@alexeyr-ci alexeyr-ci force-pushed the alexeyr/publint branch 3 times, most recently from 1874911 to 857a9a0 Compare March 4, 2025 12:09
@alexeyr-ci alexeyr-ci requested a review from Judahmeek March 4, 2025 12:22
@Judahmeek Judahmeek merged commit 264c412 into master Mar 18, 2025
11 checks passed
@Judahmeek Judahmeek deleted the alexeyr/publint branch March 18, 2025 04:14
@coderabbitai coderabbitai bot mentioned this pull request Mar 18, 2025
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.

3 participants