Skip to content

Commit 5c1bc1d

Browse files
committed
Add independent readme for docker image
Signed-off-by: Alireza Poodineh <[email protected]>
1 parent bca4ad9 commit 5c1bc1d

File tree

4 files changed

+50
-2
lines changed

4 files changed

+50
-2
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "Dotnet Multi-SDK Dev Container",
33
"build": {
4-
"dockerfile": "../Dockerfile"
4+
"dockerfile": "../build/docker/Dockerfile"
55
},
66
"customizations": {
77
"vscode": {

.github/workflows/docker.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ name: Create and publish EasyDev
44
# Configures this workflow to run every time a change is pushed to the branch called `release`.
55
on:
66
push:
7+
paths:
8+
- 'build/docker/**'
79
branches: [master]
810

911
# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
@@ -45,7 +47,7 @@ jobs:
4547
id: push
4648
uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
4749
with:
48-
context: .
50+
context: build/docker
4951
push: true
5052
tags: ${{ steps.meta.outputs.tags }}
5153
labels: ${{ steps.meta.outputs.labels }}
File renamed without changes.

build/docker/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# EasySign .NET Development Container
2+
3+
This repository contains the Dockerfile for the EasySign .NET Development Container. The container is based on the official Visual Studio Code Dev Containers image for .NET 9.0 and is pre-configured for EasySign build requirements.
4+
5+
## Features
6+
7+
- **Base Image**: Uses the official `mcr.microsoft.com/vscode/devcontainers/dotnet:9.0` image.
8+
- **Pre-installed Tools**:
9+
- `git`
10+
- `curl`
11+
- `clang`
12+
- `zlib1g-dev`
13+
- **Doxygen 1.12**: Pre-installed for generating documentation.
14+
15+
## Usage
16+
17+
To use this container, you can build it locally or pull it from a container registry. Below is an example of how to build and run the container:
18+
19+
### Build the Image
20+
21+
```bash
22+
docker build -t easydev build/docker
23+
```
24+
25+
### Pull the Container
26+
27+
```bash
28+
docker pull ghcr.io/sapteamdev/easydev:master
29+
```
30+
31+
### Use as base image
32+
33+
```
34+
FROM ghcr.io/sapteamdev/easydev:master
35+
```
36+
37+
## Environment Variables
38+
39+
- `PATH`: The container automatically includes `/usr/share/dotnet` in the `PATH`.
40+
41+
## Additional Notes
42+
43+
- The container is optimized for .NET development and includes tools for building and documenting .NET applications.
44+
- Doxygen 1.12 is installed for generating project documentation.
45+
46+
For more details, visit the [EasySign GitHub Repository](https://github.com/SAPTeamDEV/EasySign).

0 commit comments

Comments
 (0)