Add cabal-gild and update hook

IntersectMBO · Jul 4, 2024 · 8792c16 · 8792c16
1 parent a3c24ef
commit 8792c16
Show file tree

Hide file tree

Showing 5 changed files with 487 additions and 422 deletions.
diff --git a/.github/workflows/check-cabal-gild.yml b/.github/workflows/check-cabal-gild.yml
@@ -0,0 +1,53 @@
+name: Check cabal-gild format
+
+on:
+  merge_group:
+  pull_request:
+
+# When pushing branches (and/or updating PRs), we do want to cancel previous
+# build runs. We assume they are stale now; and do not want to spend CI time and
+# resources on continuing to continue those runs. This is what the concurrency.group
+# value lets us express. When using merge queues, we now have to consider
+# - runs triggers by commits per pull-request
+#   we want to cancel any previous run. So they should all get the same group (per PR)
+# - runs refs/heads/gh-readonly-queue/<target branch name> (they should all get their
+#   unique git ref, we don't want to cancel any of the ones in the queue)
+# - if it's neither, we fall back to the run_id (this is a unique number for each
+#   workflow run; it does not change if you "rerun" a job)
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.type }}-${{ startsWith(github.ref, 'refs/heads/gh-readonly-queue/') && github.ref || github.event.pull_request.number || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  check-cabal-gild:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+    env:
+      CARDANO_GUILD_VERSION: "1.3.1.2"
+
+    steps:
+    - name: Download cardano-gild
+      run: |
+        cardano_gild_path="$(mktemp -d)"
+        version="${{env.CARDANO_GUILD_VERSION}}"
+        curl -sL \
+          "https://github.com/tfausak/cabal-gild/releases/download/$version/cabal-gild-$version-linux-x64.tar.gz" \
+          | tar -C "$cardano_gild_path" -xz
+
+        echo "PATH=$cardano_gild_path:$PATH" >> "$GITHUB_ENV"
+
+    - uses: actions/checkout@v3
+
+    - name: Run cardano-gild over all modified files
+      run: |
+        git add .
+        git stash
+        git fetch origin ${{ github.base_ref }} --unshallow
+        for x in $(git diff --name-only --diff-filter=ACMR origin/${{ github.base_ref }}..HEAD "*.cabal" | tr '\n' ' '); do
+          cabal-gild -i "$x" -o "$x"
+        done
+        git --no-pager diff --exit-code
+
diff --git a/cardano-api-gen/cardano-api-gen.cabal b/cardano-api-gen/cardano-api-gen.cabal
@@ -1,47 +1,51 @@
 cabal-version: 3.0
+name: cardano-api-gen
+version: 8.2.1.0
+synopsis: Generators for the cardano api
+description: Generators for the cardano api.
+category:
+  Cardano,
+  API,
+  Test,
 
-name:                   cardano-api-gen
-version:                8.2.1.0
-synopsis:               Generators for the cardano api
-description:            Generators for the cardano api.
-category:               Cardano,
-                        API,
-                        Test,
-copyright:              2020-2023 Input Output Global Inc (IOG).
-author:                 IOHK
-maintainer:             [email protected]
-license:                Apache-2.0
-license-files:          LICENSE
-                        NOTICE
-build-type:             Simple
-extra-source-files:     README.md, CHANGELOG.md
+copyright: 2020-2023 Input Output Global Inc (IOG).
+author: IOHK
+maintainer: [email protected]
+license: Apache-2.0
+license-files:
+  LICENSE
+  NOTICE
 
-common project-config
-  default-language:     Haskell2010
-  default-extensions:   OverloadedStrings
-  build-depends:        base >= 4.14 && < 4.20
+build-type: Simple
+extra-source-files:
+  CHANGELOG.md
+  README.md
 
-  ghc-options:          -Wall
-                        -Wcompat
-                        -Wincomplete-record-updates
-                        -Wincomplete-uni-patterns
-                        -Wpartial-fields
-                        -Wredundant-constraints
-                        -Wunused-packages
+common project-config
+  default-language: Haskell2010
+  default-extensions: OverloadedStrings
+  build-depends: base >=4.14 && <4.20
+  ghc-options:
+    -Wall
+    -Wcompat
+    -Wincomplete-record-updates
+    -Wincomplete-uni-patterns
+    -Wpartial-fields
+    -Wredundant-constraints
+    -Wunused-packages
 
 library
-  import:               project-config
-
-  build-depends:        cardano-api:gen
-
-  hs-source-dirs:       src
+  import: project-config
+  build-depends: cardano-api:gen
+  hs-source-dirs: src
   -- These modules should match those in cardano-api:gen
-  exposed-modules:      Test.Gen.Cardano.Api.Empty
-  reexported-modules:   Test.Gen.Cardano.Api
-                      , Test.Gen.Cardano.Api.Metadata
-                      , Test.Gen.Cardano.Api.ProtocolParameters
-                      , Test.Gen.Cardano.Api.Typed
-                      , Test.Gen.Cardano.Crypto.Seed
-                      , Test.Hedgehog.Golden.ErrorMessage
-                      , Test.Hedgehog.Roundtrip.Bech32
-                      , Test.Hedgehog.Roundtrip.CBOR
+  exposed-modules: Test.Gen.Cardano.Api.Empty
+  reexported-modules:
+    Test.Gen.Cardano.Api,
+    Test.Gen.Cardano.Api.Metadata,
+    Test.Gen.Cardano.Api.ProtocolParameters,
+    Test.Gen.Cardano.Api.Typed,
+    Test.Gen.Cardano.Crypto.Seed,
+    Test.Hedgehog.Golden.ErrorMessage,
+    Test.Hedgehog.Roundtrip.Bech32,
+    Test.Hedgehog.Roundtrip.CBOR,