updates to ci (#236)

.github/workflows/build-test.yml

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 name: Build and Test CI
 on:
   push:

.github/workflows/codeql-analysis.yml

@@ -1,25 +1,10 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
-name: "CodeQL"
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
+name: "CodeQL"
 on:
   push:
     branches: [ main ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ main ]
-  schedule:
-    - cron: '22 19 * * 0'
-
 jobs:
   analyze:
     name: Analyze
@@ -28,33 +13,25 @@ jobs:
       actions: read
       contents: read
       security-events: write
-
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'csharp' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
         # Learn more:
         # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
-
+        language: [ 'csharp' ]
     steps:
     - name: Checkout repository
       uses: actions/checkout@v2
-
     - name: Setup NuGet.exe
       uses: NuGet/setup-nuget@v1
-
     - name: Setup .NET 5.x SDK
       uses: actions/setup-dotnet@v1
-
     - name: Setup .NET Core 3.1.x SDK
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: '3.1.x'
-
     - name: Set environment variables
       run: echo "COYOTE_CLI_TELEMETRY_OPTOUT=1" >> $GITHUB_ENV
-
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v1
@@ -64,10 +41,8 @@ jobs:
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
         # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
     - name: Build Coyote projects
       run: ./Scripts/build.ps1 -local $false
       shell: pwsh
-
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v1

.github/workflows/mkdocs-publish.yml

@@ -1,38 +0,0 @@
-# This is a basic workflow to help you get started with Actions
-
-name: Mkdocs publish
-
-# Controls when the action will run. 
-on:
-  # Triggers the workflow on push or pull request events but only for the main branch
-  push:
-    branches: [ main ]
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
-jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
-
-      - name: Install pip
-        run: python3 -m pip install --upgrade pip setuptools wheel
-
-      - name: Install MkDocs
-        run: |
-          pip install mkdocs
-          pip install mkdocs-macros-plugin
-                    
-      - name: MkDocs build 
-        run: mkdocs build
-        
-      - name: MkDocs deploy 
-        run: mkdocs gh-deploy --force

.github/workflows/publish-docs.yml

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+name: Publish Docs
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install pip
+        run: python3 -m pip install --upgrade pip setuptools wheel
+      - name: Install MkDocs
+        run: |
+          pip install mkdocs
+          pip install mkdocs-macros-plugin
+      - name: MkDocs build 
+        run: mkdocs build
+      - name: MkDocs deploy 
+        run: mkdocs gh-deploy --force

README.md

@@ -1,6 +1,5 @@
 <div align="center">
-  <img src="docs/assets/images/logo_coyote.svg" width="70%">
-  <h2>Fearless coding for reliable asynchronous software</h2>
+  <h2><img src="docs/assets/images/logo_coyote.svg" width="70%"></h2>
 </div>
 
 [![NuGet](https://img.shields.io/nuget/v/Microsoft.Coyote.svg)](https://www.nuget.org/packages/Microsoft.Coyote/)
@@ -8,9 +7,8 @@
 [![Join the chat at https://gitter.im/Microsoft/coyote](https://badges.gitter.im/Microsoft/coyote.svg)](https://gitter.im/Microsoft/coyote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Follow on Twitter](https://img.shields.io/twitter/follow/coyote_dev?style=social&logo=twitter)](https://twitter.com/intent/follow?screen_name=coyote_dev)
 
-![Windows CI](https://github.com/microsoft/coyote/workflows/Windows%20CI/badge.svg)
-![Linux CI](https://github.com/microsoft/coyote/workflows/Linux%20CI/badge.svg)
-![macOS CI](https://github.com/microsoft/coyote/workflows/macOS%20CI/badge.svg)
+![CodeQL](https://github.com/microsoft/coyote/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)
+![Build and Test CI](https://github.com/microsoft/coyote/actions/workflows/build-test.yml/badge.svg?branch=main)
 
 Coyote is a .NET library and tool designed to help ensure that your code is free of concurrency bugs.
 

Scripts/build.ps1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 param(
     [ValidateSet("Debug", "Release")]
     [string]$configuration = "Release",

Scripts/create-nuget-packages.ps1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 Import-Module $PSScriptRoot\powershell\common.psm1 -Force
 
 # Check that NuGet.exe is installed.

Scripts/encode_nuget_sign_certificate.ps1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 param(
     [Parameter(Mandatory=$true)]
     [string]$url = ""

Scripts/gen-docs.ps1

@@ -1,4 +1,5 @@
-# PowerShell v2
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
 
 $PSScriptRoot = Split-Path -Parent -Path $MyInvocation.MyCommand.Definition
 

Scripts/powershell/common.psm1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 # Invokes the specified coyote tool command on the specified target.
 function Invoke-CoyoteTool([String]$cmd, [String]$dotnet, [String]$framework, [String]$target, [String]$key) {
     Write-Comment -prefix "..." -text "Rewriting '$target' ($framework)" -color "white"

Scripts/publish-docs.ps1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 Write-Comment -prefix "." -text "Publishing the Coyote documentation to GitHub" -color "yellow"
 & mkdocs gh-deploy
 Write-Comment -prefix "." -text "Done" -color "green"

Scripts/run-benchmark-history.ps1

@@ -1,5 +1,8 @@
-# run benchmarks on entire git history using the version of the benchmark
-# test that is currently checked out, up to some given -max number of commits
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+# Run benchmarks on entire git history using the version of the benchmark test
+# that is currently checked out, up to some given -max number of commits
 param(    
     # The filter passed through to same arg on BenchmarkRunner.    
     [string]$filter = "",

Scripts/run-benchmarks.ps1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 param(
     [string]$store = "",
     [string]$key = "",

Scripts/run-tests.ps1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 param(
     [string]$dotnet = "dotnet",
     [ValidateSet("all", "net5.0", "net462")]

Scripts/test-cli-package.ps1

@@ -1,3 +1,6 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
 $ErrorActionPreference = 'Stop'
 
 Import-Module $PSScriptRoot\powershell\common.psm1 -Force