From 15eb636c2fd037a73dc42d865ae77f96a792b505 Mon Sep 17 00:00:00 2001 From: Paolo Capriotti Date: Wed, 8 Dec 2021 14:05:28 +0100 Subject: [PATCH 1/3] Generate doc files in repl phase --- services/brig/Setup.hs | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/services/brig/Setup.hs b/services/brig/Setup.hs index 49233e2b3a..b7f084b8ca 100644 --- a/services/brig/Setup.hs +++ b/services/brig/Setup.hs @@ -22,6 +22,7 @@ import Data.Maybe import Distribution.Simple import Distribution.Simple.BuildPaths import Distribution.Simple.LocalBuildInfo +import Distribution.Types.PackageDescription import System.Directory import System.FilePath @@ -30,12 +31,18 @@ main = defaultMainWithHooks simpleUserHooks { buildHook = \desc info hooks flags -> do - withLibLBI desc info $ \_ lib -> do - let base = autogenComponentModulesDir info lib "Brig" "Docs" - generateDocs base "swagger.md" - buildHook simpleUserHooks desc info hooks flags + generate desc info + buildHook simpleUserHooks desc info hooks flags, + replHook = \desc info hooks flags args -> do + generate desc info + replHook simpleUserHooks desc info hooks flags args } +generate :: PackageDescription -> LocalBuildInfo -> IO () +generate desc info = withLibLBI desc info $ \_ lib -> do + let base = autogenComponentModulesDir info lib "Brig" "Docs" + generateDocs base "swagger.md" + generateDocs :: FilePath -> FilePath -> IO () generateDocs base src = do contents <- readFile ("docs" src) From e65433f0598f1a0acd60fae0472cd5371c3c1bbd Mon Sep 17 00:00:00 2001 From: Paolo Capriotti Date: Thu, 9 Dec 2021 09:41:24 +0100 Subject: [PATCH 2/3] Update CHANGELOG entry --- changelog.d/4-docs/update-fed-error-docs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/4-docs/update-fed-error-docs b/changelog.d/4-docs/update-fed-error-docs index a0b5c094cb..79bdb088e0 100644 --- a/changelog.d/4-docs/update-fed-error-docs +++ b/changelog.d/4-docs/update-fed-error-docs @@ -1 +1 @@ -Update federation error documentation after changes to the federation API (#1956, #1978) +Update federation error documentation after changes to the federation API (#1956, #1975, #1978) From 730c1967719b78a27d9ff51705e2bb67959ad070 Mon Sep 17 00:00:00 2001 From: Paolo Capriotti Date: Thu, 9 Dec 2021 14:01:56 +0100 Subject: [PATCH 3/3] Brig: fix sdist tarball generation --- services/brig/brig.cabal | 10 +++++++--- services/brig/package.yaml | 7 ++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/services/brig/brig.cabal b/services/brig/brig.cabal index e29365f146..94a4b54168 100644 --- a/services/brig/brig.cabal +++ b/services/brig/brig.cabal @@ -1,13 +1,13 @@ -cabal-version: 1.24 +cabal-version: 2.0 -- This file has been generated from package.yaml by hpack version 0.33.0. -- -- see: https://github.com/sol/hpack -- --- hash: c37f84d005641650921717e1f340e18d82edd30045196f89649cefd53e549dfb +-- hash: 513c0f5104342fb14b0246f7c44733a84ec36fae97633fc55cb209e0e0bcd087 name: brig -version: 1.35.0 +version: 2.0 synopsis: User Service category: Network author: Wire Swiss GmbH @@ -16,6 +16,8 @@ copyright: (c) 2017 Wire Swiss GmbH license: AGPL-3 license-file: LICENSE build-type: Custom +extra-source-files: + docs/swagger.md custom-setup setup-depends: @@ -120,6 +122,8 @@ library other-modules: Paths_brig Brig.Docs.Swagger + autogen-modules: + Brig.Docs.Swagger hs-source-dirs: src default-extensions: AllowAmbiguousTypes BangPatterns ConstraintKinds DataKinds DefaultSignatures DerivingStrategies DerivingVia DeriveFunctor DeriveGeneric DeriveLift DeriveTraversable EmptyCase FlexibleContexts FlexibleInstances FunctionalDependencies GADTs InstanceSigs KindSignatures LambdaCase MultiParamTypeClasses MultiWayIf NamedFieldPuns NoImplicitPrelude OverloadedStrings PackageImports PatternSynonyms PolyKinds QuasiQuotes RankNTypes ScopedTypeVariables StandaloneDeriving TemplateHaskell TupleSections TypeApplications TypeFamilies TypeFamilyDependencies TypeOperators UndecidableInstances ViewPatterns diff --git a/services/brig/package.yaml b/services/brig/package.yaml index a790657c20..05329979f7 100644 --- a/services/brig/package.yaml +++ b/services/brig/package.yaml @@ -1,7 +1,7 @@ defaults: local: ../../package-defaults.yaml name: brig -version: '1.35.0' +version: '2.0' synopsis: User Service category: Network author: Wire Swiss GmbH @@ -17,10 +17,11 @@ custom-setup: - containers - directory - filepath +extra-source-files: + - docs/* library: source-dirs: src - other-modules: - - Paths_brig + generated-other-modules: - Brig.Docs.Swagger dependencies: - aeson >=0.11