dockgen 0.3.0

dock-gen

dock-gen is a very simple .NET tool designed to generate Dockerfiles for one or multiple projects in a solution based on dependencies in a predictable way each time.

Please note, dock-gen is still in its early stages, some features may not be stable.

Since .NET 7, dotnet comes with a built-in feature to publish app as container image. If you don't need to generate Dockerfiles, you can use the dotnet publish command to publish your application as container. For more information, see the official documentation. dock-gen is designed to provide more control over the Dockerfile generation process but it may not be suitable for all use cases.

Installation

To install dock-gen, you can use the dotnet tool install command:

1. global installation:

dotnet tool install --global dockgen

2. local installation: (optional) if you don't have a manifest file for your project, create one:

dotnet new tool-manifest

Add the tool to the manifest file:

dotnet tool install dockgen

Usage

You can use dock-gen with the generate command. This command takes two optional parameters:

• -s or --solution: To specify an absolute path to a solution file.
• -p or --project: To specify an absolute path to a project file.

Here is an example of how to use the generate command:

dotnet dockgen generate -s C:\\repos\MySolution\MySolution.sln -p C:\\repos\MySolution\MyProject\MyProject.csproj

If no solution or project file is specified, dock-gen will try to find a solution file in the current directory.

Features

• Generate Dockerfile: Generate a Dockerfile for a single or multiple projects at once
• Multi-Stage Build: Generate a multi-stage Dockerfile for a project
• Central Package/Build Management: dock-gen supports CPM/CBM in your project

Supported properties

Description for MSBuild properties can be found here: Official .NET docs

Roadmap

• Support more advanced Dockerfile customizations

Contributing

We welcome contributions to dock-gen!

License

dock-gen is open source software licensed under the MIT. See the LICENSE file for more details.

Contact

If you have any questions or feedback, please feel free to create an issue.

Acknowledgements

This project makes use of the following open source projects:

• Buildalyzer: A utility for performing design-time builds of .NET projects to obtain information such as package references and compiler flags.
• Serilog: Simple .NET logging with fully-structured events.
• .NET: .NET platform