Merge pull request #1 from serokell/Sorokin-Anton/update-xrefcheck

[Chore] Update xrefcheck to v0.2.2
serokell · Oct 28, 2022 · 60d531b · 60d531b
2 parents 336f585 + 5e95891
commit 60d531b
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 62 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -19,28 +19,38 @@ jobs:
     name: Verify cross references
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: serokell/xrefcheck-action@v1
       with:
-        xrefcheck-version: 0.2
+        xrefcheck-version: 0.2.2
 
   reuse:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: REUSE Compliance Check
       uses: fsfe/reuse-action@v1
 
   hlint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: tfausak/hlint-action@v1
+    - uses: actions/checkout@v3
+
+    - name: 'Set up HLint'
+      uses: haskell/actions/hlint-setup@v2
+      with:
+        version: '3.1.6'
+
+    - name: 'Run HLint'
+      uses: haskell/actions/hlint-run@v2
+      with:
+        path: .
+        fail-on: status
 
   stylish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Cache binaries
         id: cache-stylish
         uses: actions/cache@v3
@@ -66,7 +76,7 @@ jobs:
     name: Find Trailing Whitespace
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: harupy/[email protected]
 
   cabal:
@@ -77,7 +87,13 @@ jobs:
         os: [ubuntu-latest, macOS-latest, windows-latest]
         cabal: ["3.6"]
         # If you update this list of supported compiler versions,
-        # make sure to update the `tested-with` section of `package.yaml`.
+        # make sure to:
+        #   * Update the `tested-with` section of `package.yaml`.
+        #   * Update the list of required checks in the repo's settings.
+        #     * Go to: https://github.com/serokell/tztime/settings/branches
+        #     * Edit the "main" branch
+        #     * Scroll to "Branch protection rules" > "Require status checks to pass before merging"
+        #     * Remove versions we're not testing anymore / Add versions we're now testing.
         ghc:
           - "8.10.7"
           - "9.0.2"
@@ -93,9 +109,9 @@ jobs:
             ghc: "9.0.2"
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: haskell/actions/setup@v1.2
+    - uses: haskell/actions/setup@v2
       id: setup-haskell-cabal
       name: Setup Haskell
       with:
@@ -136,13 +152,14 @@ jobs:
             stackyaml: stack.yaml
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: haskell/actions/setup@v1.2
+    - uses: haskell/actions/setup@v2
       name: Setup Haskell Stack
       with:
         ghc-version: ${{ matrix.ghc }}
         stack-version: ${{ matrix.stack }}
+        enable-stack: true
 
     - uses: actions/cache@v3
       name: Cache ~/.stack
@@ -167,9 +184,13 @@ jobs:
     # Once hpack releases more recent binaries (see: https://github.com/sol/hpack/issues/514),
     # We should change this step to download the binaries for stack2cabal 1.0.13 and hpack >=0.34.4,
     # and then run `./hpack && ./stack2cabal --no-run-hpack`
+
+    # When this action fails with diffs involving hpack versions,
+    # try changing hpack version in snapshot-stack2cabal.yaml
     - name: Validate cabal files
       # Run this step only against the stack file we use for development.
       if: matrix.stackyaml == 'stack.yaml'
       run: |
+        stack --version;
         stack install stack2cabal --resolver snapshot-stack2cabal.yaml --system-ghc
         ./scripts/validate-cabal-files.sh
diff --git a/.xrefcheck.yaml b/.xrefcheck.yaml
@@ -2,58 +2,13 @@
 #
 # SPDX-License-Identifier: Unlicense
 
-# Parameters of repository traversal.
-traversal:
-  # Files and folders which we pretend do not exist
-  # (so they are neither analyzed nor can be referenced).
-  ignored:
-    # Git files
-    - .git
-
-    # Stack files
-    - .stack-work
-    - dist-newstyle
-
-
-# Verification parameters.
 verification:
-  # On 'anchor not found' error, how much similar anchors should be displayed as
-  # hint. Number should be between 0 and 1, larger value means stricter filter.
-  anchorSimilarityThreshold: 0.5
-
-  # When checking external references, how long to wait on request before
-  # declaring "Response timeout".
-  externalRefCheckTimeout: 10s
-
-  # Prefixes of files, references in which should not be analyzed.
-  notScanned:
-    - .github/pull_request_template.md
-    - .github/issue_template.md
-    - .github/PULL_REQUEST_TEMPLATE
-    - .github/ISSUE_TEMPLATE
-
-  # Glob patterns describing the files which do not physically exist in the
-  # repository but should be treated as existing nevertheless.
-  virtualFiles:
-    - ../../../issues
-    - ../../../issues/*
-    - ../../../pulls
-    - ../../../pulls/*
-
-  # POSIX extended regular expressions that match external references
-  # that have to be ignored (not verified).
-  # It is an optional parameter, so it can be omitted.
   ignoreRefs:
     # Note: For some reason, running `curl -I https://opensource.org/licenses/MPL-2.0` from within
     # a GitHub Action's agent returns a 503.
     # For this reason, we're temporarily disabling this check.
     - https://opensource.org/licenses/.*
 
-# Parameters of scanners for various file types.
 scanners:
-
   markdown:
-    # Flavor of markdown, e.g. GitHub-flavor.
-    #
-    # This affects which anchors are generated for headers.
     flavor: GitHub
diff --git a/snapshot-stack2cabal.yaml b/snapshot-stack2cabal.yaml
@@ -7,6 +7,6 @@ name: stack2cabal-snapshot
 
 resolver: lts-19.12
 packages:
-  - hpack-0.34.4
+  - hpack-0.35.0
   - stack2cabal-1.0.13
   - aeson-1.5.6.0
diff --git a/tztime.cabal b/tztime.cabal
@@ -1,6 +1,6 @@
 cabal-version: 1.12
 
--- This file has been generated from package.yaml by hpack version 0.34.4.
+-- This file has been generated from package.yaml by hpack version 0.35.0.
 --
 -- see: https://github.com/sol/hpack
 
@@ -107,9 +107,9 @@ library
     , time >=1.9.2
     , time-compat >=1.9.4
     , tz >=0.1.3.4
+  default-language: Haskell2010
   if impl(ghc >= 9.2)
     ghc-options: -Wno-missing-kind-signatures
-  default-language: Haskell2010
 
 test-suite tztime-doctest
   type: exitcode-stdio-1.0
@@ -175,9 +175,9 @@ test-suite tztime-doctest
   build-depends:
       base
     , doctest-parallel
+  default-language: Haskell2010
   if impl(ghc >= 9.2)
     ghc-options: -Wno-missing-kind-signatures
-  default-language: Haskell2010
 
 test-suite tztime-test
   type: exitcode-stdio-1.0
@@ -258,6 +258,6 @@ test-suite tztime-test
     , time
     , time-compat
     , tztime
+  default-language: Haskell2010
   if impl(ghc >= 9.2)
     ghc-options: -Wno-missing-kind-signatures
-  default-language: Haskell2010