Skip to content

Commit 99ddaeb

Browse files
committed
docs: update README to recommend official setup actions
- Removed references to archived Node.js and .NET SDK installation scripts from the README. - Recommended usage of GitHub Actions' official setup actions for Node.js and .NET SDK to enhance caching and version management. - Added a new README section in the archive folder for archived installation scripts with explanations for their replacement.
1 parent 57e0b50 commit 99ddaeb

File tree

6 files changed

+49
-14
lines changed

6 files changed

+49
-14
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,6 @@ The following tools are already available in the GitHub Actions runner base imag
6363
### Programming Languages & Runtimes
6464
- **Python 3** with pip - Python interpreter and package manager
6565
- **PowerShell Core** - Cross-platform PowerShell
66-
- **Node.js** (LTS 20.x) with npm - JavaScript runtime and package manager
67-
- **.NET SDK**
68-
- LTS version - Long Term Support release
69-
- STS version - Standard Term Support (latest) release
7066

7167
### Cloud & Infrastructure Tools
7268
- **Azure CLI** - Azure cloud management
@@ -237,4 +233,13 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
237233

238234
- Built on top of [actions/runner](https://github.com/actions/runner) official images
239235
- Inspired by the need for comprehensive CI/CD environments
240-
- Thanks to all contributors and the open-source community
236+
- Thanks to all contributors and the open-source community
237+
238+
## Note on .NET SDK and Node.js
239+
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:
241+
242+
- **Node.js**: Use [`actions/setup-node`](https://github.com/actions/setup-node)
243+
- **.NET SDK**: Use [`actions/setup-dotnet`](https://github.com/actions/setup-dotnet)
244+
245+
These official actions provide better caching, version management, and are optimized for CI/CD environments.

src/_archive/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Archived Scripts
2+
3+
This directory contains installation scripts that have been archived in favor of using GitHub Actions' official setup actions.
4+
5+
## Archived Scripts
6+
7+
### Node.js Installation (`scripts/install-nodejs.sh`)
8+
- **Replaced by**: [`actions/setup-node`](https://github.com/actions/setup-node)
9+
- **Reason**: The official action provides better caching, version management, and is optimized for CI/CD
10+
11+
### .NET SDK Installation (`scripts/install-dotnet-sdk.sh`)
12+
- **Replaced by**: [`actions/setup-dotnet`](https://github.com/actions/setup-dotnet)
13+
- **Reason**: The official action handles multiple SDK versions, caching, and is maintained by Microsoft
14+
15+
## Usage
16+
17+
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.
18+
19+
### Example workflow usage:
20+
21+
```yaml
22+
steps:
23+
- uses: actions/checkout@v4
24+
25+
- name: Setup Node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: '20'
29+
cache: 'npm'
30+
31+
- name: Setup .NET
32+
uses: actions/setup-dotnet@v4
33+
with:
34+
dotnet-version: |
35+
8.0.x
36+
9.0.x
37+
```
File renamed without changes.

src/scripts/install-powershell.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ else
4848
apt-get install -y --no-install-recommends \
4949
wget \
5050
apt-transport-https \
51-
software-properties-common
51+
software-properties-common \
52+
lsb-release
5253

5354
# Detect Ubuntu version
5455
UBUNTU_VERSION=$(lsb_release -rs)

src/setup.yaml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@ setup:
1919
script: "scripts/install-powershell.sh"
2020
description: "Installs PowerShell Core"
2121

22-
- name: "Install Node.js and npm"
23-
script: "scripts/install-nodejs.sh"
24-
description: "Installs Node.js and npm package manager"
25-
2622
- name: "Install Azure CLI"
2723
script: "scripts/install-azure-cli.sh"
2824
description: "Installs Azure CLI"
@@ -51,10 +47,6 @@ setup:
5147
script: "scripts/install-github-cli.sh"
5248
description: "Installs GitHub CLI (gh)"
5349

54-
- name: "Install .NET SDK"
55-
script: "scripts/install-dotnet-sdk.sh"
56-
description: "Installs .NET SDK (both LTS and latest versions)"
57-
5850
- name: "Install network tools"
5951
script: "scripts/install-network-tools.sh"
6052
description: "Installs comprehensive network utilities (DNS, IP, SSH, FTP, etc.)"

0 commit comments

Comments
 (0)