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

ci: Add sloppy /test command #33558

Merged
merged 3 commits into from
May 20, 2024
Merged

ci: Add sloppy /test command #33558

merged 3 commits into from
May 20, 2024

Conversation

sharat87
Copy link
Member

@sharat87 sharat87 commented May 18, 2024

Adds support for a /test command, without breaking the existing /ok-to-test habits.

This is a sloppy version of /ok-to-test. Turns out humans are sloppy. So let's embrace the human. 🤯

Example incantation:

/test sanity workflow

The sloppy parser at work:
shot-2024-05-18-03-40-30

Of course, if a PR body contains /ok-to-test, that takes precedence, and any /test is ignored.

We're also moving the logic of parsing the tags to a separate Javascript file. It's still not in a form that's easily testable, perhaps, but I hope this is a start for us to get to a "unit-tested CI". ❤️

@github-actions github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog CI labels May 18, 2024
@sharat87 sharat87 marked this pull request as ready for review May 18, 2024 03:46
Copy link
Contributor

coderabbitai bot commented May 18, 2024

Walkthrough

Walkthrough

The overall change to the pull request automation workflow includes implementing a new script for tag parsing from PR descriptions using actions/github-script@v7. This update centralizes the tag parsing logic into a separate file, improving code organization and maintainability. Additionally, minor formatting adjustments and restructuring were made to enhance workflow efficiency.

Changes

File Path Change Summary
.github/workflows/pr-automation.yml Updated workflow to use actions/github-script@v7 for tag extraction, along with formatting and restructuring improvements.
.github/workflows/scripts/test-tag-parser.js Added parseTags function to extract tags from PR descriptions for test configuration.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between d75afbe and 001a49f.
Files selected for processing (1)
  • .github/workflows/pr-automation.yml (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/pr-automation.yml

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

.github/workflows/scripts/test-tag-parser.js Outdated Show resolved Hide resolved
.github/workflows/scripts/test-tag-parser.js Show resolved Hide resolved
Comment on lines 1 to 44
function parseTags({core, context}) {
const body = context.payload.pull_request.body;

// "/ok-to-test" matcher. Takes precedence over the "/test" matcher.
const strictMatch = body.match(/\/ok-to-test tags="(.+?)"/)?.[1];
if (strictMatch) {
return strictMatch;
return;
}

// "/test" matcher.
const allTags = require(process.env.GITHUB_WORKSPACE + "/app/client/cypress/tags.js").Tag;
const config = body.match(/^\/test\s+(.*)$/m)?.[1] ?? "";
const concreteTags = [];

for (const [rawTag] of config.matchAll(/\w+/g)) {
console.log("Given: '" + rawTag + "'");

// See if there is exact case-insensitive match.
const exactTagMatch = allTags.find(t => t.toLowerCase() === "@tag." + rawTag);
if (exactTagMatch) {
console.log("\tMatch found:", exactTagMatch);
concreteTags.push(exactTagMatch);
continue;
}

// See if there is a singular/plural match (very rudimentary language skills).
const countedMatch = allTags.find(t => t.toLowerCase().replace(/s$/, "") === "@tag." + rawTag.replace(/s$/, ""));
if (countedMatch) {
console.log("\tMatch found:", countedMatch);
concreteTags.push(countedMatch);
continue;
}

// More smart matchers?

// No match, fail.
core.setFailed("\tNo match found for tag:", rawTag);

// We still process the rest, so we report all invalid tags in the input in a single run.
}

return concreteTags.join(", ");
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding unit tests for parseTags to ensure its robustness.

Would you like me to help by setting up some initial unit tests for this function?

sharat87 and others added 2 commits May 18, 2024 09:20
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@sharat87 sharat87 merged commit cb97394 into release May 20, 2024
13 checks passed
@sharat87 sharat87 deleted the ci/sloppy-test-command branch May 20, 2024 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants