General cleanup and changelogs

input-output-hk · Nov 13, 2023 · 9def3e7 · 9def3e7
1 parent df5795b
commit 9def3e7
Show file tree

Hide file tree

Showing 13 changed files with 121 additions and 58 deletions.
diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml
@@ -11,7 +11,7 @@ on:
   merge_group:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   build:
@@ -20,7 +20,7 @@ jobs:
     strategy:
        fail-fast: false
        matrix:
-         ghc: ["8.10.7", "9.2.8", "9.6.3", "9.8.1"]
+         ghc: ["8.4.4", "8.10.7", "9.2.8", "9.6.3", "9.8.1"]
          cabal: ["3.10.2.0"]
          os: [ubuntu-latest]
 

diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# EKG
+
+This repository contains packages to provide system metrics.
+
+- [`ekg-core`](ekg-core/README.md)
+- [`ekg-json`](ekg-json/README.md)
+- [`ekg`](ekg/README.md)
diff --git a/cabal.project b/cabal.project
@@ -1,4 +1,8 @@
+index-state:
+  , hackage.haskell.org 2023-11-10T00:00:00Z
+  , cardano-haskell-packages 2023-11-10T00:00:00Z
+
 packages:
-    ekg-core
-    ekg-json
-    ekg
+  ekg-core
+  ekg-json
+  ekg
diff --git a/ekg-core/CHANGELOG.md b/ekg-core/CHANGELOG.md
@@ -1,4 +1,8 @@
-## 0.1.2.0
+# EKG-core Changelog
+
+# Changelog entries
+
+## 0.1.2.0 (2023-11-13)
 
  * GHC 8.4-9.8 support
    ([#1](https://github.com/input-output-hk/ekg-core/pull/1)).

diff --git a/ekg-core/ekg-core.cabal b/ekg-core/ekg-core.cabal
@@ -1,20 +1,21 @@
-cabal-version:      3.0
-name:               ekg-core
-version:            0.1.2.0
-synopsis:           Tracking of system metrics
-description:        This library lets you define and track system metrics.
-homepage:           https://github.com/tibbe/ekg-core
-bug-reports:        https://github.com/tibbe/ekg-core/issues
-license:            BSD-3-Clause
-license-file:       LICENSE
-author:             Johan Tibell
+cabal-version:   3.0
+name:            ekg-core
+version:         0.1.2.0
+synopsis:        Tracking of system metrics
+description:     This library lets you define and track system metrics.
+homepage:        https://github.com/input-output-hk/ekg
+bug-reports:     https://github.com/input-output-hk/ekg/issues
+license:         BSD-3-Clause
+license-file:    LICENSE
+author:          Johan Tibell
 maintainer:
   Johan Tibell <johan.tibell@gmail.com>,
-  Mikhail Glushenkov <mikhail.glushenkov@gmail.com>
+  Mikhail Glushenkov <mikhail.glushenkov@gmail.com>,
+  operations@iohk.io
 
-category:           System
-build-type:         Simple
-extra-source-files: CHANGELOG.md
+category:        System
+build-type:      Simple
+extra-doc-files: CHANGELOG.md
 tested-with:
   GHC ==8.4.4
    || ==8.6.5
@@ -82,4 +83,5 @@ benchmark distribution
 
 source-repository head
   type:     git
-  location: https://github.com/tibbe/ekg-core.git
+  location: https://github.com/input-output-hk/ekg.git
+  subdir:   ekg-core
diff --git a/ekg-json/CHANGES.md → ekg-json/CHANGELOG.md b/ekg-json/CHANGES.md → ekg-json/CHANGELOG.md
@@ -1,6 +1,10 @@
-## 0.1.0.7 (2020-??-??)
+# EKG-json Changelog
 
- * TBD
+# Changelog entries
+
+## 0.1.1.0 (2023-11-13)
+
+ * GHC 9.8 support.
 
 ## 0.1.0.6 (2017-07-31)
 

diff --git a/ekg-json/README.md b/ekg-json/README.md
@@ -1,2 +1,3 @@
-# ekg-json [![Hackage version](https://img.shields.io/hackage/v/ekg-json.svg?label=Hackage)](https://hackage.haskell.org/package/ekg-json) [![Build Status](https://secure.travis-ci.org/tibbe/ekg-json.svg?branch=master)](http://travis-ci.org/tibbe/ekg-json)
+# ekg-json 
+
 JSON encoding of ekg metrics
diff --git a/ekg-json/changelog.d/scriv.ini b/ekg-json/changelog.d/scriv.ini
@@ -0,0 +1,13 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ekg-json.cabal: version
+categories = Patch, Non-Breaking, Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = master, main, develop
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
diff --git a/ekg-json/ekg-json.cabal b/ekg-json/ekg-json.cabal
@@ -1,13 +1,14 @@
-cabal-version:      3.0
-name:               ekg-json
-version:            0.1.0.8
-license:            BSD-3-Clause
-license-file:       LICENSE
+cabal-version:   3.0
+name:            ekg-json
+version:         0.1.1.0
+license:         BSD-3-Clause
+license-file:    LICENSE
 maintainer:
   Johan Tibell <johan.tibell@gmail.com>,
-  Mikhail Glushenkov <mikhail.glushenkov@gmail.com>
+  Mikhail Glushenkov <mikhail.glushenkov@gmail.com>,
+  operations@iohk.io
 
-author:             Johan Tibell
+author:          Johan Tibell
 tested-with:
   GHC ==8.4.4
    || ==8.6.5
@@ -18,28 +19,29 @@ tested-with:
    || ==9.6.3
    || ==9.8.1
 
-homepage:           https://github.com/tibbe/ekg-json
-bug-reports:        https://github.com/tibbe/ekg-json/issues
-synopsis:           JSON encoding of ekg metrics
+homepage:        https://github.com/input-output-hk/ekg
+bug-reports:     https://github.com/input-output-hk/ekg/issues
+synopsis:        JSON encoding of ekg metrics
 description:
   Encodes ekg metrics as JSON, using the same encoding as used by the
   ekg package, thus allowing ekg metrics to be served by other HTTP
   servers than the one used by the ekg package.
 
-category:           Distribution
-build-type:         Simple
-extra-source-files: CHANGES.md
+category:        Distribution
+build-type:      Simple
+extra-doc-files: CHANGELOG.md
 
 source-repository head
   type:     git
-  location: https://github.com/tibbe/ekg-json.git
+  location: https://github.com/input-output-hk/ekg.git
+  subdir:   ekg-json
 
 library
   exposed-modules:  System.Metrics.Json
   default-language: Haskell2010
   build-depends:
     , aeson                 ^>=2.2
-    , base                  >=4.11  && <4.20
-    , ekg-core              ^>=0.1
-    , text                  >=1.2.4 && <2.2
+    , base                  >=4.11   && <4.20
+    , ekg-core              ^>=0.1.2
+    , text                  >=1.2.4  && <2.2
     , unordered-containers  <0.3
diff --git a/ekg/CHANGES.md → ekg/CHANGELOG.md b/ekg/CHANGES.md → ekg/CHANGELOG.md
@@ -1,6 +1,10 @@
-## 0.4.0.16 (2020-??-??)
+# EKG Changelog
 
-* TBD.
+# Changelog entries
+
+## 0.4.1.0 (2023-11-13)
+
+ * GHC 9.8.1 support
 
 ## 0.4.0.15 (2018-03-20)
 

diff --git a/ekg/README.md b/ekg/README.md
@@ -0,0 +1,4 @@
+# EKG
+
+This library lets you remotely monitor a running process over HTTP. It provides
+a simple way to integrate a monitoring server into any application.
diff --git a/ekg/changelog.d/scriv.ini b/ekg/changelog.d/scriv.ini
@@ -0,0 +1,13 @@
+[scriv]
+format = md
+insert_marker = Changelog entries
+md_header_level = 2
+version = literal: ekg.cabal: version
+categories = Patch, Non-Breaking, Breaking
+end_marker = scriv-end-here
+fragment_directory = changelog.d
+ghrel_template = {{body}}
+main_branches = master, main, develop
+new_fragment_template = file: new_fragment.${config:format}.j2
+output_file = CHANGELOG.${config:format}
+skip_fragments = README.*
diff --git a/ekg/ekg.cabal b/ekg/ekg.cabal
@@ -1,11 +1,12 @@
 cabal-version:      3.0
 name:               ekg
-version:            0.4.0.16
+version:            0.4.1.0
 license:            BSD-3-Clause
 license-file:       LICENSE
 maintainer:
   Johan Tibell <johan.tibell@gmail.com>,
   Mikhail Glushenkov <mikhail.glushenkov@gmail.com>
+  operations@iohk.io
 
 author:             Johan Tibell
 tested-with:
@@ -18,8 +19,8 @@ tested-with:
    || ==9.6.3
    || ==9.8.1
 
-homepage:           https://github.com/tibbe/ekg
-bug-reports:        https://github.com/tibbe/ekg/issues
+homepage:           https://github.com/input-output-hk/ekg
+bug-reports:        https://github.com/input-output-hk/ekg/issues
 synopsis:           Remote monitoring of processes
 description:
   This library lets you remotely monitor a running process over HTTP.
@@ -38,19 +39,22 @@ data-files:
   assets/monitor.css
   assets/monitor.js
 
+extra-doc-files:
+  CHANGELOG.md
+  README.md
+
 extra-source-files:
   assets/bootstrap-1.4.0.css
   assets/jquery-1.6.4.js
   assets/jquery.flot.js
-  CHANGES.md
   examples/Basic.hs
   LICENSE.icons
   LICENSE.javascript
-  README.md
 
 source-repository head
   type:     git
-  location: https://github.com/tibbe/ekg.git
+  location: https://github.com/input-output-hk/ekg.git
+  subdir:   ekg
 
 library
   exposed-modules:
@@ -64,19 +68,20 @@ library
     System.Remote.Json
     System.Remote.Snap
 
+  autogen-modules:  Paths_ekg
   default-language: Haskell2010
   ghc-options:      -Wall
   build-depends:
     , aeson                 ^>=2.2
-    , base                  >=4.11     && <5
-    , bytestring            >=0.10     && <1.0
-    , ekg-core              ^>=0.1.2.0
-    , ekg-json              ^>=0.1.0.8
+    , base                  >=4.11   && <5
+    , bytestring            >=0.10   && <1.0
+    , ekg-core              ^>=0.1.2
+    , ekg-json              ^>=0.1.1
     , filepath              ^>=1.4
-    , network               >=2.6      && <3.2
+    , network               >=2.6    && <3.2
     , snap-core             ^>=1.0.5
     , snap-server           ^>=1.1.2
-    , text                  >=1.2.4    && <2.2
-    , time                  >=1.8      && <1.13
-    , transformers          >=0.5.5    && <0.7
-    , unordered-containers  >=0.2.15   && <0.3
+    , text                  >=1.2.4  && <2.2
+    , time                  >=1.8    && <1.13
+    , transformers          >=0.5.5  && <0.7
+    , unordered-containers  >=0.2.15 && <0.3