Enhance documentation and update dependencies

- Updated table of contents to be a header. - Added more details to the generated magefiles README. - Fixed the broken pre-commit action. - Updated mage go.mod to the latest version of goutils.
l50 · Oct 10, 2023 · 92bc47a · 92bc47a
1 parent 3c44d4a
commit 92bc47a
Show file tree

Hide file tree

Showing 23 changed files with 70 additions and 25 deletions.
diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml
@@ -1,6 +1,7 @@
 ---
 name: Pre-Commit
 on:
+  push:
   pull_request:
     types:
       - opened

diff --git a/ansible/README.md b/ansible/README.md
@@ -3,7 +3,9 @@
 The `ansible` package is a collection of utility functions
 designed to simplify common ansible tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/cloudflare/README.md b/cloudflare/README.md
@@ -3,7 +3,9 @@
 The `cloudflare` package is a collection of utility functions
 designed to simplify common cloudflare tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/dev/lint/README.md b/dev/lint/README.md
@@ -3,7 +3,9 @@
 The `lint` package is a collection of utility functions
 designed to simplify common lint tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/dev/mage/README.md b/dev/mage/README.md
@@ -3,7 +3,9 @@
 The `mageutils` package is a collection of utility functions
 designed to simplify common mageutils tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/docs/README.md b/docs/README.md
@@ -3,7 +3,9 @@
 The `docs` package is a collection of utility functions
 designed to simplify common docs tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/file/aferoutils/README.md b/file/aferoutils/README.md
@@ -3,7 +3,9 @@
 The `aferoutils` package is a collection of utility functions
 designed to simplify common aferoutils tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/file/encoderutils/README.md b/file/encoderutils/README.md
@@ -3,7 +3,9 @@
 The `encoderutils` package is a collection of utility functions
 designed to simplify common encoderutils tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/file/fileutils/README.md b/file/fileutils/README.md
@@ -3,7 +3,9 @@
 The `file` package is a collection of utility functions
 designed to simplify common file tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/git/README.md b/git/README.md
@@ -3,7 +3,9 @@
 The `git` package is a collection of utility functions
 designed to simplify common git tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/logging/README.md b/logging/README.md
@@ -3,7 +3,9 @@
 The `logging` package is a collection of utility functions
 designed to simplify common logging tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/macos/README.md b/macos/README.md
@@ -3,7 +3,9 @@
 The `macos` package is a collection of utility functions
 designed to simplify common macos tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/magefiles/README.md b/magefiles/README.md
@@ -1,8 +1,12 @@
 # goutils/v2/magefiles
 
 `magefiles` provides utilities that would normally be managed
-and executed with a `Makefile`.
-Table of contents:
+and executed with a `Makefile`. Instead of being written in the make language,
+magefiles are crafted in Go and leverage the [Mage](https://magefile.org/) library.
+
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Contributing](#contributing)

diff --git a/magefiles/go.mod b/magefiles/go.mod
@@ -3,7 +3,7 @@ module magefile
 go 1.21
 
 require (
-	github.com/l50/goutils/v2 v2.1.2-0.20231009200725-762b8d121fc2
+	github.com/l50/goutils/v2 v2.1.2
 	github.com/magefile/mage v1.15.0
 	github.com/spf13/afero v1.10.0
 )

diff --git a/magefiles/go.sum b/magefiles/go.sum
@@ -181,8 +181,8 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/l50/goutils/v2 v2.1.2-0.20231009200725-762b8d121fc2 h1:Wm5AhO4VmtBg3l+OFV1igdos8tyfKMtO6LGSk3u7qrM=
-github.com/l50/goutils/v2 v2.1.2-0.20231009200725-762b8d121fc2/go.mod h1:TRwb4J9shutlQb/XqadyaqQ2mSBVoxq+AfOHTSzDmhY=
+github.com/l50/goutils/v2 v2.1.2 h1:H9TcYlQPgO/TeW36Qxg7/usbKj3DM2rikx8joHaQ2wc=
+github.com/l50/goutils/v2 v2.1.2/go.mod h1:TRwb4J9shutlQb/XqadyaqQ2mSBVoxq+AfOHTSzDmhY=
 github.com/magefile/mage v1.15.0 h1:BvGheCMAsG3bWUDbZ8AyXXpCNwU9u5CB6sM+HNb9HYg=
 github.com/magefile/mage v1.15.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
 github.com/matryer/is v1.2.0 h1:92UTHpy8CDwaJ08GqLDzhhuixiBUUD1p3AU6PHddz4A=

diff --git a/magefiles/tmpl/README.md.tmpl b/magefiles/tmpl/README.md.tmpl
@@ -3,8 +3,12 @@
 {{if ne .PackageName "magefiles"}}The `{{.PackageName}}` package is a collection of utility functions
 designed to simplify common {{.PackageName}} tasks.
 {{else}}`{{.PackageName}}` provides utilities that would normally be managed
-and executed with a `Makefile`.{{end}}
-Table of contents:
+and executed with a `Makefile`. Instead of being written in the make language,
+magefiles are crafted in Go and leverage the [Mage](https://magefile.org/) library.
+{{end}}
+---
+
+## Table of contents
 
 - [Functions](#functions){{if ne .PackageName "magefiles"}}
 - [Installation](#installation)

diff --git a/net/README.md b/net/README.md
@@ -3,7 +3,9 @@
 The `net` package is a collection of utility functions
 designed to simplify common net tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/pwmgr/README.md b/pwmgr/README.md
@@ -3,7 +3,9 @@
 The `pwmgr` package is a collection of utility functions
 designed to simplify common pwmgr tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/pwmgr/keeper/README.md b/pwmgr/keeper/README.md
@@ -3,7 +3,9 @@
 The `keeper` package is a collection of utility functions
 designed to simplify common keeper tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/str/README.md b/str/README.md
@@ -3,7 +3,9 @@
 The `str` package is a collection of utility functions
 designed to simplify common str tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/sys/README.md b/sys/README.md
@@ -3,7 +3,9 @@
 The `sys` package is a collection of utility functions
 designed to simplify common sys tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/web/README.md b/web/README.md
@@ -3,7 +3,9 @@
 The `web` package is a collection of utility functions
 designed to simplify common web tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)

diff --git a/web/cdpu/README.md b/web/cdpu/README.md
@@ -3,7 +3,9 @@
 The `cdpu` package is a collection of utility functions
 designed to simplify common cdpu tasks.
 
-Table of contents:
+---
+
+## Table of contents
 
 - [Functions](#functions)
 - [Installation](#installation)