Merge branch 'master' into 2021-11-10-add-gen-hie-note

Author: Anton-Latukha

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+
+  # NOTE: Dependabot official configuration documentation:
+  # https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates#package-ecosystem
+
+  # Maintain dependencies for internal GitHub Actions CI for pull requests
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/bench.yml

@@ -17,7 +17,7 @@ jobs:
       should_skip: ${{ steps.skip_check.outputs.should_skip }}
     steps:
       - id: skip_check
-        uses: fkirc/[email protected].0
+        uses: fkirc/[email protected].1
         with:
           cancel_others: false
           paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**.nix", "**/test/**", "flake.lock", "**/README.md", "FUNDING.yml"]'

.github/workflows/nix.yml

@@ -21,12 +21,12 @@ jobs:
       should_skip_build: ${{ steps.skip_check_no_nix.outputs.should_skip }}
     steps:
       - id: skip_check
-        uses: fkirc/skip-duplicate-actions@master
+        uses: fkirc/skip-duplicate-actions@v3.4.1
         with:
           cancel_others: false
           paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", ".circleci/**", "install/**", "**/README.md", "FUNDING.yml"]'
       - id: skip_check_no_nix
-        uses: fkirc/skip-duplicate-actions@master
+        uses: fkirc/skip-duplicate-actions@v3.4.1
         with:
           cancel_others: false
           paths: '["**.nix"]'
@@ -46,7 +46,7 @@ jobs:
     - uses: actions/checkout@v2
       with:
         submodules: true
-    - uses: cachix/install-nix-action@v13
+    - uses: cachix/install-nix-action@v14.1
       with:
         install_url: https://nixos-nix-install-tests.cachix.org/serve/i6laym9jw3wg9mw6ncyrk6gjx4l34vvx/install
         install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
@@ -81,7 +81,7 @@ jobs:
     - uses: actions/checkout@v2
       with:
         submodules: true
-    - uses: cachix/install-nix-action@v13
+    - uses: cachix/install-nix-action@v14.1
       with:
         install_url: https://nixos-nix-install-tests.cachix.org/serve/i6laym9jw3wg9mw6ncyrk6gjx4l34vvx/install
         install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'

.github/workflows/test.yml

@@ -22,13 +22,13 @@ jobs:
       should_skip_ghcide: ${{ steps.skip_ghcide_check.outputs.should_skip }}
     steps:
       - id: skip_check
-        uses: fkirc/[email protected].0
+        uses: fkirc/[email protected].1
         with:
           cancel_others: false
           paths_ignore: '["**/docs/**", "**.md", "**/LICENSE", "install/**", "**.nix", "flake.lock", "**/README.md", "FUNDING.yml", ".circleci/**"]'
       # If we only change ghcide downstream packages we have not test ghcide itself
       - id: skip_ghcide_check
-        uses: fkirc/[email protected].0
+        uses: fkirc/[email protected].1
         with:
           cancel_others: false
           paths_ignore: '["hls-test-utils/**", "plugins/**", "src/**", "exe/**", "test/**", "shake-bench/**"]'

docs/contributing/contributing.md

@@ -113,17 +113,17 @@ $ cabal run haskell-language-server:func-test -- -p "hlint enables"
 
 ## Using HLS on HLS code
 
-Generally, project now should work without any `hie.yaml` configuration placed.
+Project source code is made to load without any `hie.yaml` configuration placed. If to say - implicit detection of configuration should work now.
 
 In other cases:
-1. If there are `hie.yaml` (& `hie.yml`) files - try to backup them, remove & load project without them.
-2. Note that many subdirectories of a project are in itself are subprojects, & if main project needs special configuration - they need be hooked-up also.
+1. Check if `hie.yaml` (& `hie.yml`) files left from previous efforts to configure.
+2. Note that many subdirectories of a project are in itself are subprojects, & if main project needs special configuration - they probably need also.
 
-In implicit configuration detection does not work & to create a mock configuration for all projects - use [implicit-hie](https://github.com/Avi-D-coder/implicit-hie) generator directly to put configuration explicitly - it would add configuarations for all projects at once by:
+If implicit configuration detection does not work. To create a mock configuration for all projects - use [implicit-hie](https://github.com/Avi-D-coder/implicit-hie) generator directly to put configuration explicitly - it would add configuarations for all projects at once by:
 ```shell
 gen-hie > hie.yaml  # into the main HLS directory
 ```
-that configuration now can be inspected, it may work out of the box or can be tuned further with custom configuration.
+& try that configuration - it may work out of the bos, & that configuration can be inspected & tuned further.
 
 [Configuring project build](../configuration.md#configuring-your-project-build) applies to HLS project source code loading just as to any other.