Skip to content

Commit a4dab73

Browse files
committed
docs(README): update Kubernetes tools recommendations
- Removed installation scripts for Kubernetes tools from README and added links to official GitHub Actions setup actions. - Updated note in README to include Kubernetes tools alongside .NET SDK and Node.js. - Provided reasons for using official actions for better version management and caching. - Archived installation script for Kubernetes tools to emphasize reliance on official actions.
1 parent 99ddaeb commit a4dab73

File tree

4 files changed

+23
-12
lines changed

4 files changed

+23
-12
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,6 @@ The following tools are already available in the GitHub Actions runner base imag
7373
- **Docker Compose Plugin** - Multi-container orchestration (latest)
7474
- **Docker Buildx** - Advanced Docker builds (pre-installed in base image)
7575

76-
### Kubernetes Tools
77-
- **kubectl** - Kubernetes CLI (latest stable)
78-
- **Helm** - Kubernetes package manager (latest)
79-
- **Kustomize** - Kubernetes configuration management (latest)
80-
8176
### Development Tools
8277
- **Git** - Version control (pre-installed in base image)
8378
- **GitHub CLI** (`gh`) - GitHub operations (latest)
@@ -235,11 +230,14 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
235230
- Inspired by the need for comprehensive CI/CD environments
236231
- Thanks to all contributors and the open-source community
237232

238-
## Note on .NET SDK and Node.js
233+
## Note on .NET SDK, Node.js, and Kubernetes Tools
239234

240-
While .NET SDK and Node.js installation scripts are available in the `src/_archive/scripts/` directory, we recommend using GitHub Actions' official setup actions for these tools in your workflows:
235+
While installation scripts for these tools are available in the `src/_archive/scripts/` directory, we recommend using GitHub Actions' official setup actions or marketplace actions in your workflows:
241236

242237
- **Node.js**: Use [`actions/setup-node`](https://github.com/actions/setup-node)
243238
- **.NET SDK**: Use [`actions/setup-dotnet`](https://github.com/actions/setup-dotnet)
239+
- **kubectl**: Use [`azure/setup-kubectl`](https://github.com/azure/setup-kubectl)
240+
- **Helm**: Use [`azure/setup-helm`](https://github.com/azure/setup-helm)
241+
- **Kustomize**: Use [`imranismail/setup-kustomize`](https://github.com/imranismail/setup-kustomize)
244242

245-
These official actions provide better caching, version management, and are optimized for CI/CD environments.
243+
These actions provide better caching, version management, and are optimized for CI/CD environments.

src/_archive/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ This directory contains installation scripts that have been archived in favor of
1212
- **Replaced by**: [`actions/setup-dotnet`](https://github.com/actions/setup-dotnet)
1313
- **Reason**: The official action handles multiple SDK versions, caching, and is maintained by Microsoft
1414

15+
### Kubernetes Tools Installation (`scripts/install-kubernetes-tools.sh`)
16+
- **Replaced by**:
17+
- kubectl: [`azure/setup-kubectl`](https://github.com/azure/setup-kubectl)
18+
- Helm: [`azure/setup-helm`](https://github.com/azure/setup-helm)
19+
- Kustomize: [`imranismail/setup-kustomize`](https://github.com/imranismail/setup-kustomize)
20+
- **Reason**: These actions provide version management, caching, and are maintained by the community
21+
1522
## Usage
1623

1724
These scripts are preserved for reference and can still be used if you need to install these tools directly in the Docker image. However, for GitHub Actions workflows, we recommend using the official setup actions.
@@ -34,4 +41,14 @@ steps:
3441
dotnet-version: |
3542
8.0.x
3643
9.0.x
44+
45+
- name: Setup kubectl
46+
uses: azure/setup-kubectl@v4
47+
with:
48+
version: 'latest'
49+
50+
- name: Setup Helm
51+
uses: azure/setup-helm@v4
52+
with:
53+
version: 'latest'
3754
```
File renamed without changes.

src/setup.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ setup:
3535
script: "scripts/install-docker-tools.sh"
3636
description: "Installs Docker Compose plugin"
3737

38-
- name: "Install Kubernetes tools"
39-
script: "scripts/install-kubernetes-tools.sh"
40-
description: "Installs kubectl, helm, and kustomize"
41-
4238
- name: "Install yamllint"
4339
script: "scripts/install-yamllint.sh"
4440
description: "Installs yamllint for YAML validation"

0 commit comments

Comments
 (0)