chore: add docs (#20)

danteay · Apr 17, 2024 · 0d9ece7 · 0d9ece7
1 parent ad5f0f3
commit 0d9ece7
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 6 deletions.
diff --git a/.github/workflows/tag_logger.yml b/.github/workflows/tag_logger.yml
@@ -24,8 +24,8 @@ jobs:
           fetch-depth: 2
           ref: "main"
 
-      - name: Fetch tags for adapter
-        run: git fetch --tags origin '+refs/tags/adapters/${{ matrix.adapter }}/*:refs/tags/adapters/${{ matrix.adapter }}/*'
+      - name: Fetch tags
+        run: git fetch --tags origin '+refs/tags/v*:refs/tags/v*'
 
       - name: Files modified
         id: check

diff --git a/.github/workflows/tag_modules.yml b/.github/workflows/tag_modules.yml
@@ -29,8 +29,8 @@ jobs:
           fetch-depth: 2
           ref: "main"
 
-      - name: Fetch tags for adapter
-        run: git fetch --tags origin '+refs/tags/adapters/${{ matrix.adapter }}/*:refs/tags/adapters/${{ matrix.adapter }}/*'
+      - name: Fetch tags for modules
+        run: git fetch --tags origin '+refs/tags/${{ matrix.adapter }}/*:refs/tags/${{ matrix.adapter }}/*'
 
       - name: Files modified
         id: check

diff --git a/go.sum b/go.sum
@@ -1,5 +1,3 @@
-github.com/danteay/golog/adapters/slog v0.2.0 h1:out+V8wxc9Qn4cXso13pLKJG18EJI7gAjy4xvnV43v4=
-github.com/danteay/golog/adapters/slog v0.2.0/go.mod h1:OmDON9G8qJecuoFjHVyzXb/tIDSH6J9/VW2+4NujrGQ=
 github.com/danteay/golog/adapters/slog v0.2.1 h1:Mduw+0EVFGA3fHJJ9u24nUM9ZrndWSBgWxocyJ9/Puo=
 github.com/danteay/golog/adapters/slog v0.2.1/go.mod h1:PuACPq2sOwQFEo1hWwfIz7HwwsvSbQn15KMezZm/rkA=
 github.com/danteay/golog/fields v0.1.0 h1:/W3Gh3PrVoJsY53sear+yzyLRkIMkM039lOfSNfUFj0=

diff --git a/logger.go b/logger.go
@@ -15,6 +15,7 @@ type Adapter interface {
 	Log(level levels.Level, err error, logFields *fields.Fields, msg string, args ...any)
 }
 
+// Logger is the main struct that holds the logger instance.
 type Logger struct {
 	ctx    context.Context
 	logger Adapter