Release version 0.8.0

svengreb · Nov 15, 2022 · 48c5316 · 48c5316
1 parent df29129
commit 48c5316
Show file tree

Hide file tree

Showing 96 changed files with 182 additions and 123 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Configurations for EditorConfig.
 # See https://editorconfig.org/#file-format-details for more details.

diff --git a/.gitattributes b/.gitattributes
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Configuration to define attributes per path.
 #

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Configuration for the GitHub feature to automatically request reviews from the code owners
 # when a pull request changes any owned files.

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,6 +1,6 @@
 <!-- Click on the "Preview" tab to render the instructions in a more readable format -->
 
-> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/CONTRIBUTING.md) before filling out this issue template**.
+> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/contributing.md) before filling out this issue template**.
 
 ## [Please follow one of the issue templates](https://github.com/svengreb/wand/issues/new/choose)
 

diff --git a/.github/ISSUE_TEMPLATE/bugs.md b/.github/ISSUE_TEMPLATE/bugs.md
@@ -5,7 +5,7 @@ about: Report a bug that is caused by the code in this repository
 
 <!-- Click on the "Preview" tab to render the instructions in a more readable format -->
 
-> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/CONTRIBUTING.md) before filling out this issue template**.
+> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/contributing.md) before filling out this issue template**.
 
 ## Prerequisites
 
@@ -42,7 +42,7 @@ What actually happens?
 
 ## Example
 
-Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/svengreb/wand/blob/main/CONTRIBUTING.md#mcve)
+Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/svengreb/wand/blob/main/contributing.md#mcve)
 
 **This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the bug.**
 The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.

diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -5,7 +5,7 @@ about: Submit an enhancement suggestion for new features or minor improvements t
 
 <!-- Click on the "Preview" tab to render the instructions in a more readable format -->
 
-> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/CONTRIBUTING.md) before filling out this issue template**.
+> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/contributing.md) before filling out this issue template**.
 
 ## Prerequisites
 
@@ -40,7 +40,7 @@ If you've considered alternative features or solutions please describe it clearl
 
 ## Example
 
-Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/svengreb/wand/blob/main/CONTRIBUTING.md#mcve)
+Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/svengreb/wand/blob/main/contributing.md#mcve)
 
 **This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement.**
 The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://docs.github.com/en/github/managing-your-work-on-github/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://docs.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) into this issue.

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,6 @@
 <!-- Click on the "Preview" tab to render the instructions in a more readable format -->
 
-> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/CONTRIBUTING.md) before filling out this pull request template**.
+> **Please read the [contribution guidelines](https://github.com/svengreb/wand/blob/main/contributing.md) before filling out this pull request template**.
 
 ## Prerequisites
 
@@ -9,7 +9,7 @@ This section and the instructions in the sections below are only part of this pu
 Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug fix to help maintainers and the community understand and reproduce the behavior, find related pull requests and to merge it faster.
 
 - **Ensure the pull request has not already been submitted by using the [GitHub Pull Request search](https://github.com/svengreb/wand/pulls)** — check if this enhancement or bug fix has already been suggested. If it has **and the pull request is still open**, add your additions as comment or [suggest a change](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request#applying-a-suggested-change) to the existing pull request instead of opening a new one. If you find a closed pull request that seems to be similar to this one, include a link to the original pull request in the [metadata head](#metadata-head) section of this new pull request.
-- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/svengreb/wand/blob/main/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
+- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/svengreb/wand/blob/main/contributing.md#pull-requests)**, especially the one for tests and documentations.
 - **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/svengreb/wand/releases/latest) and [`main`](https://github.com/svengreb/wand/tree/main) branch to ensure that the enhancement or bug fix has not already been added.
 
 ## Metadata Head

diff --git a/.github/workflows/ci-go.yaml b/.github/workflows/ci-go.yaml
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # GitHub Action Workflow for continuous integration jobs.
 # See https://docs.github.com/en/actions and https://github.com/features/actions for more details.

diff --git a/.github/workflows/ci-node.yaml b/.github/workflows/ci-node.yaml
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # GitHub Action Workflow for continuous integration jobs.
 # See https://docs.github.com/en/actions and https://github.com/features/actions for more details.

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Path match pattern to intentionally ignore untracked files and directories.
 # See https://git-scm.com/docs/gitignore for more details.

diff --git a/.golangci.yml b/.golangci.yml
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Configuration for golangci-lint.
 # See https://golangci-lint.run/usage/configuration for more details.
@@ -130,7 +130,7 @@ linters-settings:
         EMAIL: .*@svengreb\.de
     template: |-
       Copyright (c) {{ YEAR }} {{ AUTHOR }} <{{ EMAIL }}>
-      This source code is licensed under the MIT license found in the LICENSE file.
+      This source code is licensed under the MIT license found in the license file.
 
   goimports:
     # A comma-separated list of prefixes for local package imports to be put after 3rd-party packages.

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,7 +1,7 @@
 #!/bin/sh
 
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Git "pre-commit" hook for husky.
 #

diff --git a/.idea/watcherTasks.xml b/.idea/watcherTasks.xml
diff --git a/.mailmap b/.mailmap
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Configuration for the Git mail mapping feature to coalesce together commits by the same person in the shortlog,
 # where their name and/or email address was spelled differently or has been changed.

diff --git a/.npmrc b/.npmrc
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Configurations for npm.
 # See https://docs.npmjs.com/cli/v7/configuring-npm/npmrc for more details.

diff --git a/.prettierignore b/.prettierignore
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Path match pattern to ignore (i.e. not reformat) certain files and folders.
 # See https://prettier.io/docs/en/ignore for more details.

diff --git a/.remarkignore b/.remarkignore
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Path match pattern to ignore when searching for files.
 # See https://github.com/unifiedjs/unified-engine/blob/HEAD/doc/ignore.md for more details.

diff --git a/.remarkrc.js b/.remarkrc.js
@@ -1,6 +1,6 @@
 /*
  * Copyright (c) 2019-present Sven Greb <[email protected]>
- * This source code is licensed under the MIT license found in the LICENSE file.
+ * This source code is licensed under the MIT license found in the license file.
  */
 
 /**

diff --git a/.wand/.gitignore b/.wand/.gitignore
@@ -1,5 +1,5 @@
 # Copyright (c) 2019-present Sven Greb <[email protected]>
-# This source code is licensed under the MIT license found in the LICENSE file.
+# This source code is licensed under the MIT license found in the license file.
 
 # Path match pattern to intentionally ignore untracked files and directories.
 # See https://git-scm.com/docs/gitignore for more details.

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,42 @@
 
 <!--lint disable no-duplicate-headings no-duplicate-headings-in-section-->
 
+# 0.8.0
+
+![Release Date: 2022-11-15](https://img.shields.io/static/v1?style=flat-square&label=Release%20Date&message=2022-11-15&colorA=4c566a&colorB=88c0d0) [![Project Board](https://img.shields.io/static/v1?style=flat-square&label=Project%20Board&message=0.8.0&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/users/svengreb/projects/6/views/3) [![Milestone](https://img.shields.io/static/v1?style=flat-square&label=Milestone&message=0.6.0&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/svengreb/wand/milestone/9)
+
+⇅ [Show all commits][187]
+
+## Improvements
+
+<details>
+<summary><strong>Improve <code>runtime/debug</code> Go 1.18 incompatibility via stable <code>go.mod</code> file parsing</strong> — #129 ⇄ #130 (⊶ df291299)</summary>
+
+↠ [As of Go 1.18][192] the [debug.ReadBuildInfo][193] function does not work for Mage executables anymore because the way how module information is stored changed. Therefore the fields of the returned [debug.Module][194] type only has zero values, including the module path. The [debug.Module.Version][195] field has a [default value][196] (`(devel)`) which is not Semver compatible and causes the parsing to fail. [The change in Go 1.18][200] also [came with the new `debug/buildinfo` package][201] which allows to read the information from compiled binaries while the `runtime/debug.ReadBuildInfo` function returns information from within the running binary. Both are not suitable anymore which is also described in the Go 1.18 `version` command release notes:
+
+> The underlying data format of the embedded build information can change with new `go` releases, so an older version of `go` may not handle the build information produced with a newer version of `go`. To read the version information from a binary built with `go` 1.18, use the `go` version command and the `debug/buildinfo` package from `go` 1.18+.
+
+To get the required module information that was previously provided by the [runtime/debug][197] package the official [golang.org/x/mod/modfile][198] package is now used instead that provides the implementation for a parser and formatter for [`go.mod` files][199] [^1]. This allows to safely get the module path without the need to depend on runtime/dynamic logic that might change in future Go versions.
+
+Note that **this change also increased the minimum Go version from `1.17` to `1.19`!**
+
+</details>
+
+## Bug Fixes
+
+<details>
+<summary><strong>Update to <code>tmpl-go</code> template repository version <code>0.11.0</code> and <code>0.12.0</code></strong> — #112, #127 ⇄ #113, #128 (⊶ a4e2a38f, c4fe6cfc)</summary>
+
+↠ Updated to [`tmpl-go` version `0.11.0`][203] and [`0.12.0`][204] which…
+
+1. [fixed `golangci-lint` running errors due to `revive`s unknown `time-equal` rule][189].
+2. [disabled the `revive` linter rule `package-comments`][190].
+3. [updated to the `tmpl` template repository version `0.11.0`][202].
+
+See the [full `tmpl-go` version `0.11.0`][203] and [`0.12.0`][204] and changelogs for all details.
+
+</details>
+
 # 0.7.0
 
 ![Release Date: 2021-11-21](https://img.shields.io/static/v1?style=flat-square&label=Release%20Date&message=2021-11-21&colorA=4c566a&colorB=88c0d0) [![Project Board](https://img.shields.io/static/v1?style=flat-square&label=Project%20Board&message=0.7.0&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/svengreb/wand/projects/11) [![Milestone](https://img.shields.io/static/v1?style=flat-square&label=Milestone&message=0.6.0&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/svengreb/wand/milestone/8)
@@ -840,7 +876,7 @@ It is customizable through the following functions:
 
 <p align="center">Copyright &copy; 2019-present <a href="https://www.svengreb.de" target="_blank" rel="noreferrer">Sven Greb</a></p>
 
-<p align="center"><a href="https://github.com/svengreb/wand/blob/main/LICENSE" target="_blank" rel="noreferrer"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>
+<p align="center"><a href="https://github.com/svengreb/wand/blob/main/license" target="_blank" rel="noreferrer"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>
 
 <!--
 +------------------+
@@ -890,6 +926,7 @@ otherwise Markdown elements are not parsed and rendered!
 [21]: https://trunkbaseddevelopment.com/monorepos
 [22]: https://en.wikipedia.org/wiki/Harry_Potter
 [58]: https://pkg.go.dev/golang.org/x/tools/cmd/goimports
+[115]: https://github.com/actions/setup-node
 
 <!-- v0.1.0 -->
 
@@ -996,7 +1033,6 @@ otherwise Markdown elements are not parsed and rendered!
 <!-- v0.4.1 -->
 
 [114]: https://github.com/actions/setup-node/compare/v2.1.3...c46424ee
-[115]: https://github.com/actions/setup-node
 [116]: https://github.com/svengreb/wand/compare/v0.4.0...v0.4.1
 [117]: https://github.com/magefile/mage/compare/v1.10.0...v1.11.0
 [118]: https://pkg.go.dev/os/#Environ
@@ -1074,3 +1110,26 @@ otherwise Markdown elements are not parsed and rendered!
 [184]: https://github.com/svengreb/tmpl-go/releases/tag/v0.10.0
 [185]: https://github.com/svengreb/tmpl-go/issues/72
 [186]: https://github.com/svengreb/tmpl-go/issues/74
+
+<!-- v0.8.0 -->
+
+[187]: https://github.com/svengreb/wand/compare/v0.7.0...v0.7.1
+[189]: https://github.com/svengreb/tmpl-go/issues/76
+[190]: https://github.com/svengreb/tmpl-go/issues/78
+[192]: https://github.com/golang/go/commit/9cec77ac#diff-abdadaf0d85a2e6c8e45da716909b2697d830b0c75149b9e35accda9c38622bdR2234
+[193]: https://pkg.go.dev/runtime/[email protected]#ReadBuildInfo
+[194]: https://pkg.go.dev/runtime/debug#Module
+[195]: https://github.com/golang/go/blob/9cec77ac/src/runtime/debug/mod.go#L52
+[196]: https://github.com/golang/go/blob/122a22e0e9eba7fe712030d429fc4bcf6f447f5e/src/cmd/go/internal/load/pkg.go#L2288
+[197]: https://pkg.go.dev/runtime/[email protected]
+[198]: https://pkg.go.dev/golang.org/x/mod/modfile
+[199]: https://pkg.go.dev/cmd/go#hdr-The_go_mod_file
+[200]: https://tip.golang.org/doc/go1.18#go-version
+[201]: https://tip.golang.org/doc/go1.18#debug/buildinfo
+[202]: https://github.com/svengreb/tmpl-go/issues/91
+[203]: https://github.com/svengreb/tmpl-go/releases/tag/v0.11.0
+[204]: https://github.com/svengreb/tmpl-go/releases/tag/v0.12.0
+
+<!--lint disable no-duplicate-definitions-->
+
+[^1]: https://go.dev/ref/mod#go-mod-file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -177,10 +177,10 @@ Thanks for the inspirations and attributions to GitHub's [Open Source Guides][26
 
 [1]: http://sscce.org
 [2]: https://semver.org
-[3]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md
+[3]: https://github.com/atom/atom/blob/master/contributing.md
 [4]: https://github.com/svengreb/wand/tree/main
-[5]: https://github.com/svengreb/wand/blob/main/CHANGELOG.md
-[6]: https://github.com/svengreb/wand/blob/main/CODE_OF_CONDUCT.md
+[5]: https://github.com/svengreb/wand/blob/main/changelog.md
+[6]: https://github.com/svengreb/wand/blob/main/code_of_conduct.md
 [7]: https://gist.github.com
 [8]: https://github.com/svengreb/wand/labels/type-question
 [9]: https://github.com/svengreb/wand/blob/main/.github/ISSUE_TEMPLATE/bugs.md