Skip to content

Commit

Permalink
added local run doc
Browse files Browse the repository at this point in the history
  • Loading branch information
mostafa6765 committed Sep 2, 2024
1 parent e3d8654 commit 57314e1
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,17 @@ terrafrom-terragrunt-aws-project

---

# Run locally

## update config file
The `config.json` file contains essential configurations for Terraform and Terragrunt. You should update this file to match your environment and branch-specific settings.

## cli command

```bash
./run.sh
```

# Run GitHub Action (Terragrunt Plan and Apply)

## Setting Up GitHub Secrets
Expand All @@ -46,14 +57,6 @@ To ensure that the GitHub Action workflow runs correctly, you need to set up the

- **`TF_API_TOKEN`**: This is a Terraform Cloud API token used for authentication.

**Steps to Add the Secret**:
1. Navigate to your GitHub repository.
2. Click on the "Settings" tab.
3. In the left sidebar, click on "Secrets and variables" and then "Actions".
4. Click on the "New repository secret" button.
5. Enter `TF_API_TOKEN` as the secret name and provide your Terraform Cloud API token as the value.
6. Click "Add secret" to save it.

## Update Config File

The `config.json` file contains essential configurations for Terraform and Terragrunt. You should update this file to match your environment and branch-specific settings.
Expand Down

0 comments on commit 57314e1

Please sign in to comment.