|
1 | | -# .NET Core Build Scripts |
| 1 | +# .NET Core Source-Build |
2 | 2 |
|
| 3 | +[](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release%2F3.1) |
3 | 4 | [](https://gitter.im/dotnet/source-build?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
4 | 5 |
|
5 | | -<!-- Use scripts/generate-readme-table.sh to update table. --> |
6 | | -<!-- Generated table start --> |
7 | | -| OS | *Azure DevOps*<br/>Release | |
8 | | -| -- | :-- | |
9 | | -| CentOS7.1 | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
10 | | -| CentOS7.1 (Online) | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
11 | | -| CentOS7.1 (Offline) | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
12 | | -| CentOS7.1 (Offline Portable) | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
13 | | -| Debian8.2 | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
14 | | -| Debian8.2 (Online) | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
15 | | -| Fedora29 | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
16 | | -| Fedora29 (Online) | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
17 | | -| Fedora29 (Offline) | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
18 | | -| Fedora29 (Offline Portable) | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
19 | | -| OSX | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
20 | | -| Ubuntu16.04 | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
21 | | -| Windows | [](https://dev.azure.com/dnceng/internal/_build/latest?definitionId=114&branchName=release/3.0) | |
22 | | -<!-- Generated table end --> |
| 6 | +This repository contains infrastructure for building the .NET Core Runtime and SDK from source. The scripts allow .NET Core package maintainers to comply with common Linux distribution guidelines. |
23 | 7 |
|
24 | | -This repository contains a set of scripts for building the .NET Core Runtime and SDK from source. The scripts were built to make it easy for anyone to build the .NET Core product. |
| 8 | +## Using this repository |
25 | 9 |
|
26 | | -You can use these scripts to build the .NET Core product for Windows, macOS or Linux. See [Documentation](Documentation) for complete instructions. |
| 10 | +The scripts are written for Bash and supported on macOS and Linux. See [Documentation](Documentation) for complete instructions. |
27 | 11 |
|
28 | | -## Using the Scripts |
29 | | - |
30 | | -The scripts are supported on Windows, macOS and Linux. The scripts are based on PowerShell on Windows and Bash on macOS and Linux. Currently, Windows scripts only build through core-setup and do not build the complete SDK. |
31 | | - |
32 | | -If you are building on Windows or OSX, building is possible via Docker. (https://hub.docker.com/r/microsoft/dotnet/) |
33 | | - |
34 | | -### Build on Windows |
35 | | - |
36 | | -```console |
37 | | -./build.ps1 |
38 | | -``` |
| 12 | +> The source-build repository doesn't currently support Windows. See [source-build#1190](https://github.com/dotnet/source-build/issues/1190). |
39 | 13 |
|
40 | 14 | ### Build on Linux or macOS |
41 | 15 |
|
42 | 16 | ```console |
43 | 17 | ./build.sh |
44 | 18 | ``` |
45 | 19 |
|
46 | | -## Script Users |
47 | | - |
48 | | -The most common users are expected to be: |
49 | | - |
50 | | -* .NET Core contributors. |
51 | | -* Linux distribution maintainers. |
52 | | -* Cloud service developers. |
53 | | - |
54 | | -You do not have to build the entire product to contribute to .NET Core. Often, you only need to build a single binary to test a change. There are some scenarios where building the whole product is useful, such as adding and testing a feature that requires changes to multiple repos. |
| 20 | +## Goals |
55 | 21 |
|
56 | | -## What the Scripts Do |
| 22 | +The key goal of this repository is to satisfy the official packaging rules of commonly used Linux distributions, such as [Fedora](https://fedoraproject.org/wiki/Packaging:Guidelines) and [Debian](https://www.debian.org/doc/manuals/maint-guide/build.en.html). Many Linux distributions have similar rules. These rules tend to have two main principles: consistent reproducibility, and source code for everything. |
57 | 23 |
|
58 | | -The scripts can be thought of as solving challenges that would otherwise making building the whole product difficult. The following challenges are the primary ones that developers often hit before these scripts were available. |
| 24 | +A secondary goal of source-build is to allow .NET Core contributors to build a .NET Core SDK with coordinated changes in multiple repositories. However, the developer experience is significantly better in individual repositories and, if possible, contributors should make and test changes in the target repo, not source-build. |
59 | 25 |
|
60 | | -* .NET Core is composed of several repositories that all need to be built. |
61 | | -* The .NET Core SDK generated by the build requires a specific layout in order to correctly function. |
62 | | -* Most of the product is written in managed code and requires the .NET Core SDK to build. This approach is a great use of the product, but presents a boot-strapping problem for the build. |
| 26 | +## What does the source-build infrastructure do? |
63 | 27 |
|
64 | | -## Goals |
| 28 | +Source-build solves common challenges that most developers encounter when trying to build the whole .NET Core SDK from source. |
65 | 29 |
|
66 | | -Many Linux distributions have specific rules for official packages. The rules can be summarized as two main rules: source for everything, and consistent reproducibility. |
| 30 | +* .NET Core is composed of many repositories that need to be built at a specific combination of commits. |
| 31 | +* Each repository's build output needs to flow into the next repository's build. |
| 32 | +* By default, most .NET Core repositories download prebuilt binary dependencies from online sources. These are forbidden by typical Linux distribution rules, and interfere with build output flow. |
| 33 | +* Nearly all .NET Core repositories require the .NET Core SDK to build. This is a circular dependency, which presents a bootstrapping problem. |
67 | 34 |
|
68 | | -A key goal of this repository was to satisfy the official packaging rules of commonly used Linux distributions, such as [Fedora](https://fedoraproject.org/wiki/Packaging:Guidelines) and [Debian](https://www.debian.org/doc/manuals/maint-guide/build.en.html). |
| 35 | +The source-build repository contains scripts and build logic to help Linux distribution maintainers address these challenges. |
69 | 36 |
|
70 | 37 | ## License |
71 | 38 |
|
72 | | -This repo is licensed with [MIT](LICENSE.txt). |
| 39 | +This repo is licensed under the [MIT](LICENSE.txt) license. |
0 commit comments