Merge pull request #2 from piraces/next

Next version for dotnex: stable 1.0.0

Author: piraces

.github/workflows/docs.yml

@@ -0,0 +1,25 @@
+name: .NET Docs publish
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  publish:
+    runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+    - name: Install docfx via Chocolatey
+      run: choco install docfx -y
+    - name: Install docfx via Chocolatey
+      run: choco install docfx -y
+    - name: Generate documentation
+      run: cd docs; docfx .\docfx.json --build
+    - name: Deploy to Github Pages
+      uses: crazy-max/ghaction-github-pages@v2
+      with:
+        build_dir: docs/_site
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/dotnet.yml renamed to .github/workflows/dotnet-release.yml

@@ -11,6 +11,11 @@ jobs:
     - uses: actions/checkout@v2
     - name: Setup .NET
       uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: | 
+          3.1.x
+          5.0.x
+          6.0.x
     - name: Restore dependencies
       run: dotnet restore
     - name: Pack

.github/workflows/dotnet-test.yml

@@ -0,0 +1,26 @@
+name: .NET CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: | 
+          3.1.x
+          5.0.x
+          6.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore
+    # - name: Test
+    #   run: dotnet test --no-build --verbosity normal

.gitignore

@@ -350,4 +350,13 @@ MigrationBackup/
 .ionide/
 
 # JetBrains IDEs
-.idea/
+.idea/
+
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
+/**/docs/doc/*.yml
+/**/docs/doc/.manifest

Directory.Build.targets

@@ -1,6 +1,11 @@
 <Project>
     <ItemGroup>
-        <PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.1.0-beta-20204-02" />
-        <PackageReference Update="System.CommandLine" Version="2.0.0-beta1.20574.7" />
+		<PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.1.1" />
+		<PackageReference Update="System.CommandLine" Version="2.0.0-beta2.21617.1" />
+    <PackageReference Update="FluentAssertions" Version="6.4.0" />
+    <PackageReference Update="Microsoft.NET.Test.Sdk" Version="17.0.0" />
+    <PackageReference Update="xunit" Version="2.4.1" />
+    <PackageReference Update="xunit.runner.visualstudio" Version="2.4.3" />
+    <PackageReference Update="coverlet.collector" Version="3.1.0" />
     </ItemGroup>
 </Project>

README.md

@@ -19,6 +19,7 @@ This simple tool provides the minimum necessary to run dotnet tools without the
 
 - **SourceLink for debugging**. The binaries can be debbuged with [Source Link](https://github.com/dotnet/sourcelink). Example (with Developer Command Prompt for VS): `devenv /debugexe c:\Users\rich\.dotnet\tools\dotnex.exe`
 
+- **Symbols package**. A symbols package is published too in the publish process in order to ease the debugging of the NuGet package.
 
 
 ## Usage
@@ -29,14 +30,15 @@ dotnex [options] <TOOL> [<TOOL-ARGS>...]
 Where the arguments and options are the following:
 ```
 Arguments:
-  <TOOL>         The NuGet Package Id of the tool to execute
-  <TOOL-ARGS>    Arguments to pass to the tool to execute
+  <TOOL>       The NuGet Package Id of the tool to execute []
+  <TOOL-ARGS>  Arguments to pass to the tool to execute
 
 Options:
-  -v, --version <version>        Version of the tool to use
-  -f, --framework <framework>    Target framework for the tool
-  -r, --remove-cache             Flag to remove the local cache before running the tool (can be run without tool)
-  -?, -h, --help                 Show help and usage information
+  -v, --use-version <use-version>  Version of the tool to use
+  -f, --framework <framework>      Target framework for the tool
+  -r, --remove-cache               Flag to remove the local cache before running the tool (can be run without tool)
+  --version                        Show version information
+  -?, -h, --help                   Show help and usage information
 ```
 
 This same output can be obtained running the tool with the help option:
@@ -59,14 +61,19 @@ dotnet tool install -g dotnex
 
 ### SDK version
 
-`dotnex` is actually built for .NET 5. The main idea is to maintain `dotnex` up-to-date with the current, most stable release of dotnet recommended to use at the date by Microsoft.
+`dotnex` is published for all current supported SDKs from Microsoft:
+- .NET Core 3.1.x
+- .NET 5.0.x
+- .NET 6.0.x
+
+The main idea is to maintain `dotnex` up-to-date with all current supported SDKs from Microsoft.
 
 ## Contributions
 
 Feel free to open an issue or a PR if you want to without any problem :)
 
 ## License
 
-This project is licensed under the [MIT License](./LICENSE).
+This project is licensed under the [MIT License](LICENSE).
 
 See the `LICENSE` file in the root of this repository.

docs/apidoc/.gitkeep

@@ -0,0 +1,6 @@
+# Introduction
+
+This simple tool provides the minimum necessary to run dotnet tools without the need of installing them globally or in a project, since this is not yet supported in dotnet cli.
+
+It is a similar approach to [npx](https://www.npmjs.com/package/npx) from [npm](https://www.npmjs.com/).
+

docs/articles/intro.md

@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md

docs/articles/toc.yml

@@ -0,0 +1,3 @@
+# Explore the source code documentation
+
+Click around and find how **dotnex** works!