From 7762ea1339bffaaf89b6300f3be1fd86583762f3 Mon Sep 17 00:00:00 2001 From: Tristan Watson Date: Thu, 8 Aug 2024 10:49:31 +0100 Subject: [PATCH] chore(docs): updating to reflect rename of actions for ENG-872 --- .vscode/settings.json | 2 +- CONTRIBUTING.md | 10 +++++----- README.md | 6 +++--- examples/define-version/action.yml | 2 +- examples/general-use/README.md | 12 ++++++------ examples/general-use/action.yml | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 7dd1560..8dc9484 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,5 @@ { "yaml.schemas": { - "https://json.schemastore.org/github-action.json": "file:///Users/triwats/src/oak/oak-actions/actions/terraform/action.yml" + "https://json.schemastore.org/github-action.json": "/actions/terraform/action.yml" } } \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cfa04d..35f617d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,13 @@ -### Contributing to Oak Actions +### Contributing to Oak Terraform Actions -Thank you for your interest in contributing to the Oak Actions repository! We welcome and appreciate your contributions. Here’s how you can get started: +Thank you for your interest in contributing to the Oak Terrafor Actions repository! We welcome and appreciate your contributions. Here’s how you can get started: ## How to Contribute 1. **Fork the Repository**: Click on the fork button to create your copy of the repository. 2. **Clone Your Fork**: Clone the forked repository to your local machine. ```bash - git clone https://github.com/your-username/oak-actions.git + git clone https://github.com/your-username/oak-terraform-actions.git ``` 3. **Create a Branch**: Create a new branch for your feature or bug fix. ```bash @@ -44,7 +44,7 @@ When submitting a pull request, you will be presented with our Pull Request Temp ## Code of Conduct -Please adhere to the [Code of Conduct](https://github.com/oaknational/oak-actions/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming and respectful environment for all contributors. +Please adhere to the [Code of Conduct](https://github.com/oaknational/oak-terraform-actions/blob/main/CODE_OF_CONDUCT.md) to ensure a welcoming and respectful environment for all contributors. ## Getting Help @@ -54,4 +54,4 @@ If you need help, feel free to open an issue or ask for assistance in your pull We appreciate your contributions and look forward to collaborating with you! 🚀 -For more details, visit the [Oak Actions repository](https://github.com/oaknational/oak-actions). +For more details, visit the [Oak Terraform Actions repository](https://github.com/oaknational/oak-terraform-actions). diff --git a/README.md b/README.md index 2530392..f206178 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# oak-actions +# oak-terraform-actions The `actions` folder is designed to house reusable GitHub Actions, making it easy to manage and share automation across different repositories. Each subfolder within `actions` contains a specific action with all necessary files and documentation. @@ -37,7 +37,7 @@ jobs: steps: - name: Run Terraform Action from oak-terraform-actions - uses: oaknational/oak-actions/actions/terraform@main + uses: oaknational/oak-terraform-actions/actions/terraform@main ``` -For more details, visit the [oaknational/oak-actions repository](https://github.com/oaknational/oak-actions). +For more details, visit the [Oak Terraform Actions repository](https://github.com/oaknational/oak-terraform-actions). diff --git a/examples/define-version/action.yml b/examples/define-version/action.yml index 5b594c8..04facff 100644 --- a/examples/define-version/action.yml +++ b/examples/define-version/action.yml @@ -7,6 +7,6 @@ jobs: runs-on: ubuntu-latest steps: - name: Run Terraform Checks Action from oak-terraform-actions - uses: oaknational/oak-actions/actions/terraform-checks@main + uses: oaknational/oak-terraform-actions/actions/terraform-checks@main with: terraform_version: 1.5.7 # or any other version as needed diff --git a/examples/general-use/README.md b/examples/general-use/README.md index 6fd1768..b2198fe 100644 --- a/examples/general-use/README.md +++ b/examples/general-use/README.md @@ -1,6 +1,6 @@ -### Using the Terraform Action from `oaknational/oak-actions` +### Using the Terraform Action from `oaknational/oak-terraform-actions` -To use the Terraform action from the `oaknational/oak-actions` repository in your GitHub workflows, follow these steps: +To use the Terraform action from the `oaknational/oak-terraform-actions` repository in your GitHub workflows, follow these steps: 1. **Create a Workflow File**: In your target repository, create a `.github/workflows` directory if it doesn't exist. @@ -22,15 +22,15 @@ jobs: - name: Checkout repository uses: actions/checkout@v2 - - name: Run Terraform Action from oak-actions - uses: oaknational/oak-actions/actions/terraform@main + - name: Run Terraform Action from oak-terraform-actions + uses: oaknational/oak-terraform-actions/actions/terraform@main with: example_input: "value" ``` ### Explanation -- **uses: oaknational/oak-actions/actions/terraform@main**: Specifies the action from the `oak-actions` repository. +- **uses: oaknational/oak-terraform-actions/actions/terraform@main**: Specifies the action from the `oak-terraform-actions` repository. - **example_input**: Replace this with the actual input parameters required by the Terraform action 😉. -This setup allows you to incorporate the reusable Terraform action in your CI/CD workflows. For more details, visit the [oaknational/oak-actions repository](https://github.com/oaknational/oak-actions). +This setup allows you to incorporate the reusable Terraform action in your CI/CD workflows. For more details, visit the [oaknational/oak-terraform-actions repository](https://github.com/oaknational/oak-terraform-actions). diff --git a/examples/general-use/action.yml b/examples/general-use/action.yml index 818b502..0634c8c 100644 --- a/examples/general-use/action.yml +++ b/examples/general-use/action.yml @@ -8,6 +8,6 @@ jobs: steps: - name: Run Terraform Action from oak-terraform-actions - uses: oaknational/oak-actions/actions/terraform@main + uses: oaknational/oak-terrform-actions/actions/terraform@main with: example_input: "value"