Remove cache at the end of workflow run

[brettcurtis]

Fixes #150

Summary by CodeRabbit

• New Features

  • Added a "Delete cache" step to the workflow for improved cache management.

• Updates

  • Upgraded versions of pre-commit hooks for Terraform and Checkov to enhance security and functionality.

• Refactor

  • Renamed a module from "test" to "project" to better reflect its purpose, along with corresponding updates to project ID references.

[coderabbitai]

Walkthrough

The pull request introduces several changes across different files. A new job step for deleting a Terraform workspace cache has been added to the GitHub Actions workflow. Additionally, the versions of two pre-commit hook repositories have been updated to their latest releases. Furthermore, a module in the Terraform configuration has been renamed, along with an update to the corresponding project ID reference.

Changes

File	Change Summary
.github/workflows/plan-and-apply.yml	Added a new job step named "Delete cache" to delete a Terraform workspace cache using GitHub CLI.
.pre-commit-config.yaml	Updated pre-commit-terraform version from v1.92.0 to v1.96.1 and checkov from 3.2.174 to 3.2.255.
tests/plan-and-apply/main.tf	Renamed module from "test" to "project" and updated project ID reference accordingly.

Possibly related PRs

• Support for optional verbose boolean for Terraform test workflow #141: Modifications to GitHub Actions workflows, including the introduction of a new input parameter for the Terraform test workflow, which relates to enhancing workflow configurations in Terraform.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 90927e5 and 8beed6d.

Files selected for processing (3)

• .github/workflows/plan-and-apply.yml (1 hunks)
• .pre-commit-config.yaml (2 hunks)
• tests/plan-and-apply/main.tf (2 hunks)

Additional comments not posted (5)

tests/plan-and-apply/main.tf (2)

39-39: LGTM! Verify the attribute name change in the module's output.

The project ID reference change from module.test.project_id to module.project.id is necessary to align with the module name change. However, the attribute name has also changed from project_id to id. Verify that this change is consistent with the module's output.

Run the following script to verify the module's output:

#!/bin/bash
# Description: Verify the module's output attribute name.

# Test: Search for the module's output block. Expect: The output attribute is named "id".
rg --type terraform $'output "id"' $(fd --type d --max-depth 1 "terraform-google-project")

---

4-4: LGTM! Verify the module name change across the codebase.

The module name change from "test" to "project" is a valid refactor. Ensure that this change is consistently applied across the codebase.

Run the following script to verify the module usage:

Verification successful

---

Module name change verified successfully

The verification process has confirmed that:

• The old module name 'test' has been completely removed from all .tf files.
• The new module name 'project' is correctly used in tests/plan-and-apply/main.tf.
• There are no inconsistencies or lingering references to the old module name in the codebase.

The module name change has been successfully and consistently applied.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all references to the module have been updated to use the new name.

# Test: Search for the old module name. Expect: No occurrences.
rg --type terraform $'module "test"'

# Test: Search for the new module name. Expect: Only occurrences of the new name.
rg --type terraform $'module "project"'

Length of output: 306

---

Script:

#!/bin/bash
# Description: Verify all references to the module have been updated to use the new name.

# Test: Search for the old module name. Expect: No occurrences.
echo "Searching for old module name 'test':"
fd -e tf | xargs grep -n 'module "test"' || echo "No occurrences found."

echo ""

# Test: Search for the new module name. Expect: Only occurrences of the new name.
echo "Searching for new module name 'project':"
fd -e tf | xargs grep -n 'module "project"'

Length of output: 390

.pre-commit-config.yaml (2)

14-14: LGTM!

Updating the pre-commit-terraform repository to the latest version v1.96.1 is a good practice to ensure the latest pre-commit hooks for Terraform are used. This update is unlikely to introduce any breaking changes or compatibility issues.

---

35-35: LGTM!

Updating the checkov repository to the latest version 3.2.255 is a good practice to ensure the latest version of the Checkov security scanning tool is used. This update is unlikely to introduce any breaking changes or compatibility issues.

.github/workflows/plan-and-apply.yml (1)

272-274: LGTM!

The new "Delete cache" step looks good. It correctly deletes the cache at the end of the workflow run using the same cache key as the one used to set up the cache in the "plan" job.

Deleting the cache ensures that future workflow runs start with a clean slate and helps reduce storage usage.

---

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.