* Adding linux build.sh

* Removing CRLF difference from a unit test

* Documenting getting started and system requirements

* Minor text update
This commit is contained in:
Louis DeJardin 2018-09-12 15:16:47 -07:00 коммит произвёл GitHub
Родитель 805bd9271f
Коммит d612266a0a
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 70 добавлений и 4 удалений

Просмотреть файл

@ -22,7 +22,9 @@ With Atlas you can make the configuration of everything from CI/CD to production
## Install
Daily builds of the Atlas CLI are available as self-contained downloads.
Atlas is currently under active development.
Daily builds of the Atlas CLI are available as self-contained downloads:
| Platform | [Master branch (0.1)][Master Branch] | [Latest build][Latest Json] |
|:------:|:------:|:------:|
@ -34,6 +36,50 @@ If you want to use a package manager:
#### Chocolatey
* [Chocolatey](https://chocolatey.org/) users can use `choco install atlas-cli -s https://www.myget.org/F/atlas-ci`
## Getting Started
From a console window, `mkdir hello` to create a new subfolder.
Add a `hello/workflow.yaml` file to declare operations:
```
operations:
- message: Running my workflow...
- message: {{ info.greeting }}, {{ info.name }}!
- message: "All values: {{ json . }}"
```
Add a `hello/values.yaml` file to declare defaults:
```
info:
greeting: Hello
name: World
```
Run it!
```
> atlas deploy hello --set info.name=Atlas
Atlas
- Running my workflow...
- Hello, Atlas!
- All values: {"info": {"greeting": "Hello", "name": "Atlas"}}
```
Clone the [Atlas Examples](https://github.com/Microsoft/Atlas/tree/master/examples) folder to see additional
kinds of operations Atlas can perform.
```
git clone https://github.com/Microsoft/Atlas.git
cd Atlas/examples
atlas deploy 101-messages
```
## Features
* [YAML] or [JSON] syntax to define workflows and input parameters
@ -82,13 +128,21 @@ If you want to use a package manager:
Atlas runs on Windows and Linux. Windows 10 and Ubuntu 16.04 are the tested environments.
#### Building from source
#### Building Atlas from source
Prerequisites:
* Required: Download and [install](https://www.microsoft.com/net/download/dotnet-core/2.1) the .NET Core SDK
* Optional: [Install](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2017) or [update](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2017) Visual Studio 2017
* Optional: Download and [install](https://code.visualstudio.com/Download) Visual Studio Code
To clone and build from source, run the following commands from a console window:
```
git clone https://github.com/Microsoft/Atlas.git
cd Atlas
build.cmd *or* ./build.sh
```
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to

12
build.sh Normal file
Просмотреть файл

@ -0,0 +1,12 @@
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
BinFolder="${DIR}/bin"
dotnet restore src/Microsoft.Atlas.CommandLine/Microsoft.Atlas.CommandLine.csproj
dotnet build src/Microsoft.Atlas.CommandLine/Microsoft.Atlas.CommandLine.csproj -c Release
dotnet test test/Microsoft.Atlas.CommandLine.Tests/Microsoft.Atlas.CommandLine.Tests.csproj -c Release
dotnet publish src/Microsoft.Atlas.CommandLine/Microsoft.Atlas.CommandLine.csproj -c Release -o ${BinFolder}/atlas
dotnet msbuild src/Microsoft.Atlas.CommandLine/Microsoft.Atlas.CommandLine.csproj /t:Restore,CreateTarball /p:RuntimeIdentifier=linux-x64 /p:TargetFramework=netcoreapp2.0 /p:Configuration=Release /p:ArchiveDir=${BinFolder}/downloads
dotnet msbuild src/Microsoft.Atlas.CommandLine/Microsoft.Atlas.CommandLine.csproj /t:Restore,CreateZip /p:RuntimeIdentifier=win10-x64 /p:TargetFramework=netcoreapp2.0 /p:Configuration=Release /p:ArchiveDir=${BinFolder}/downloads
dotnet pack src/Microsoft.Atlas.CommandLine.Chocolatey/Microsoft.Atlas.CommandLine.Chocolatey.csproj -o ${BinFolder}/chocolatey

Просмотреть файл

@ -173,8 +173,8 @@ eta:
var yaml = serializers.YamlSerializer.Serialize(data);
// yaml serializer writes blank value for null
var expected = GetYamlRepresentation();
var actual = yaml;
var expected = GetYamlRepresentation().Replace("\r", string.Empty);
var actual = yaml.Replace("\r", string.Empty);
Assert.AreEqual(expected, actual);
}