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

Bullrich/unify jobs #3

Closed
wants to merge 9 commits into from
Closed

Bullrich/unify jobs #3

wants to merge 9 commits into from

Conversation

Bullrich
Copy link

@Bullrich Bullrich commented Feb 22, 2024

Unified all the tests into having one final step at the end.

image

This step will only run if all the previous steps have ran. If any of these tests fail, it will fail.

All the status checks will still appear in the PR, so the user can see any failed case:
image

But, by adding this last test as the only requirement, the list to block the branch becomes significantly smaller.

  • Does not require a CHANGELOG entry

Summary by CodeRabbit

  • Chores
    • Improved CI workflows to ensure database migrations and all tests pass before merging changes.

Bullrich and others added 9 commits February 19, 2024 16:46
Test was singular, it should be plural
The matrix jobs are already depended by other jobs. We can simply remove their dependency
It looks a bit better than simply adding a print line statement
Let's unify everything at once
Added a shorter name to make it easier to understand
Copy link

coderabbitai bot commented Feb 22, 2024

Walkthrough

The recent updates introduce new verification jobs to the CI/CD pipeline, enhancing the robustness of the development process. Specifically, these changes ensure that both migrations and tests are thoroughly checked for success before proceeding, running on the latest Ubuntu environment. This initiative enhances the reliability and integrity of the codebase by ensuring that key components such as database migrations and various tests (runtime, integration, and build-chain specifications) are validated.

Changes

File Path Change Summary
.github/workflows/check-migrations.yml Added confirmMigrationsPassed job to confirm migration success.
.github/workflows/test.yml Added confirmTestPassed job to ensure all tests pass, dependent on multiple test jobs.

🐇✨
In the land of code and byte,
Where tests and migrations take their flight,
A rabbit hopped with utmost care,
To check the code was sound and fair.
"All's well!" it cheered, with a leap so bold,
In a tale of quality, forever told.
🌟🐾

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@Bullrich
Copy link
Author

@coderabbitai review

Copy link

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

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 959b830 and cb2f032.
Files selected for processing (2)
  • .github/workflows/check-migrations.yml (1 hunks)
  • .github/workflows/test.yml (1 hunks)

Comment on lines +115 to +121
confirmMigrationsPassed:
runs-on: ubuntu-latest
name: All migrations passed
# If any new job gets added, be sure to add it to this list
needs: [check-migrations]
steps:
- run: echo '### Good job! All the migrations passed 🚀' >> $GITHUB_STEP_SUMMARY
Copy link

Choose a reason for hiding this comment

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

The addition of the confirmMigrationsPassed job is a good practice for centralizing the success confirmation of migration-related tests. However, consider adding a conditional step or job status check to explicitly handle the scenario where the check-migrations job fails. This would improve clarity and maintainability by explicitly documenting the intended behavior in failure scenarios.

Comment on lines +208 to +217
runs-on: ubuntu-latest
name: All tests passed
# If any new job gets added, be sure to add it to this list
needs:
- runtime-test
- integration-test
- build-chain-spec-generator
steps:
- run: echo '### Good job! All the tests passed 🚀' >> $GITHUB_STEP_SUMMARY
Copy link

Choose a reason for hiding this comment

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

The addition of the confirmTestPassed job is a solid approach to streamline the testing process by having a single job that confirms the success of all tests. Similar to the previous file, consider adding a conditional step or job status check to handle scenarios where any of the dependent jobs (runtime-test, integration-test, build-chain-spec-generator) fail. This would ensure that the workflow's behavior in failure scenarios is clear and maintainable.

@Bullrich Bullrich closed this Mar 1, 2024
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.

1 participant