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 manual trigger #31

Merged
merged 1 commit into from
Nov 15, 2024
Merged

ci: add manual trigger #31

merged 1 commit into from
Nov 15, 2024

Conversation

italopessoa
Copy link
Member

No description provided.

Copy link

coderabbitai bot commented Nov 15, 2024

Walkthrough

The changes introduce a new trigger, workflow_dispatch, to the GitHub Actions workflow defined in .github/workflows/terraform.yaml. This addition allows for manual triggering of the workflow alongside the existing pull_request event. The overall structure of the workflow remains unchanged, with existing jobs for tasks such as Terraform configuration, testing, and deployment retained without modification.

Changes

File Change Summary
.github/workflows/terraform.yaml Added workflow_dispatch: trigger for manual workflow execution.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub Actions
    participant Terraform Jobs

    User->>GitHub Actions: Trigger workflow (manual or pull_request)
    GitHub Actions->>Terraform Jobs: Execute jobs (settings, test, sonarcloud, plan, deploy, seed, destroy)
    Terraform Jobs-->>GitHub Actions: Completion status
    GitHub Actions-->>User: Notify completion
Loading

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 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 or @coderabbitai title 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.

Copy link

sonarcloud bot commented Nov 15, 2024

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.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
.github/workflows/terraform.yaml (1)

Line range hint 44-45: Update job conditions to handle manual triggers

The current job conditions don't account for manual workflow runs. Consider updating the following conditions to include workflow_dispatch:

  1. Test job:
- if: github.event_name == 'push'
+ if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
  1. SonarCloud job:
- if: github.event_name == 'pull_request' || github.ref == 'refs/heads/main'
+ if: github.event_name == 'pull_request' || github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'
  1. Terraform Plan job:
- if: github.event_name == 'pull_request'
+ if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch'
  1. Deploy job:
- if: github.ref == 'refs/heads/main'
+ if: github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch'

This ensures that manual triggers go through the same validation steps as automated runs.

Also applies to: 71-72, 91-92, 147-148

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8315556 and a91fce3.

📒 Files selected for processing (1)
  • .github/workflows/terraform.yaml (1 hunks)
🔇 Additional comments (2)
.github/workflows/terraform.yaml (2)

7-7: LGTM: Manual trigger addition

The addition of workflow_dispatch trigger enhances workflow flexibility by allowing manual runs.


Line range hint 15-16: LGTM: Security controls are well-maintained

The workflow maintains proper security controls with:

  • Appropriate permission restrictions
  • Environment-gated deployments
  • Proper secrets handling

Copy link

Terraform Cloud Plan Output

```
Plan: 3 to add, 0 to change, 0 to destroy.
```
[Terraform Cloud Plan](https://app.terraform.io/app/FiapPostech-SOAT/workspaces/bmb-database/runs/run-YuMDtvonQQtZFq3T)

@italopessoa italopessoa merged commit f6f2314 into main Nov 15, 2024
8 checks passed
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