Merge pull request #428 from andrewflbarnes/feature/changelog

doc: Inclued changelog file and script

CHANGELOG.md

@@ -0,0 +1,185 @@
+# Changelog
+
+This file is generated by `./changelog.sh`
+
+## [0.5.7] - 2024-03-12
+
+### Contributions
+
+- Merge pull request [#349](https://github.com/jenv/jenv/issues/349) from [stirlingcarter](https://github.com/stirlingcarter)/master
+- Merge pull request [#391](https://github.com/jenv/jenv/issues/391) from [andrewflbarnes](https://github.com/andrewflbarnes)/bugfix/doctor-no-plugin-exit-code
+- Merge pull request [#393](https://github.com/jenv/jenv/issues/393) from [andrewflbarnes](https://github.com/andrewflbarnes)/bugfix/sh-command-eval
+- Merge pull request [#405](https://github.com/jenv/jenv/issues/405) from [jsoref](https://github.com/jsoref)/add-no-args
+- Merge pull request [#406](https://github.com/jenv/jenv/issues/406) from [jsoref](https://github.com/jsoref)/spelling
+- Merge pull request [#414](https://github.com/jenv/jenv/issues/414) from [nfawcett](https://github.com/nfawcett)/issue-328-show-remove-in-useful-command-list
+- Merge pull request [#417](https://github.com/jenv/jenv/issues/417) from [JacksonBailey](https://github.com/JacksonBailey)/master
+- Merge pull request [#421](https://github.com/jenv/jenv/issues/421) from [Friendseeker](https://github.com/Friendseeker)/fix-jenv-doctor-interpolation
+
+### Bug Fixes
+
+- Interpolation adding extra eval
+- Jenv doctor exit code when no plugins are enabled
+- Jenv doctor plugin checks
+- Jenv init so sh-* commands are correctly evaluated
+- Jenv versions command
+- Jenv-add shortest version for posix and osx
+
+### Documentation
+
+- Update readme to use cask-versions
+
+### Miscellaneous Tasks
+
+- Gracefully handle `jenv add`
+- Improve phrasing for initial doctor check and export plugin
+- Update libexec/jenv-add
+- Show remove in useful command list
+- Spelling deactivate
+- Spelling macos
+- Spelling options
+
+## [0.5.6] - 2023-02-14
+
+### Miscellaneous Tasks
+
+- Use a silent way in fish to check if jenv exists for #321
+
+## [0.5.5] - 2022-06-04
+
+### Contributions
+
+- Merge pull request [#269](https://github.com/jenv/jenv/issues/269) from [emcrisostomo](https://github.com/emcrisostomo)/remove-accept-multiple-args
+- Merge pull request [#288](https://github.com/jenv/jenv/issues/288) from [lawalib](https://github.com/lawalib)/sync-JDK_HOME-with-JAVA_HOME
+- Merge pull request [#313](https://github.com/jenv/jenv/issues/313) from [isomarcte](https://github.com/isomarcte)/fix-single-digit-version-parsing
+- Merge pull request [#321](https://github.com/jenv/jenv/issues/321) from [0az](https://github.com/0az)/fish-hook
+- Merge pull request [#327](https://github.com/jenv/jenv/issues/327) from [RayBB](https://github.com/RayBB)/patch-1
+- Merge pull request [#330](https://github.com/jenv/jenv/issues/330) from [creasty](https://github.com/creasty)/patch-1
+- Merge pull request [#346](https://github.com/jenv/jenv/issues/346) from [combscCode](https://github.com/combscCode)/patch-1
+- Merge pull request [#353](https://github.com/jenv/jenv/issues/353) from [kwon37xi](https://github.com/kwon37xi)/master
+- Merge pull request [#355](https://github.com/jenv/jenv/issues/355) from [marquiswang](https://github.com/marquiswang)/default_shell
+
+### Revert
+
+- "Assume unknown shells are bash-compatible"
+
+### Bug Fixes
+
+- Jenv-init for shells without typeset
+
+### Documentation
+
+- Add quotes around command substitution
+
+### Miscellaneous Tasks
+
+- Add some unit tests usings docker and bats
+- Assume unknown shells are bash-compatible
+- Don't run jenv javahome twice in zsh
+- Improve shell detection code
+- Remove obsolete export.fish
+- Replace source+psub
+- Silence fish export hook if jenv not in path
+- Update jenv-add To Handle Versions With No '.'
+- Update jenv-remove to accept multiple arguments
+- Add JDK providers - zulu, zulu_primetemurin, jetbrains, kona, openlogic, semeru, semeru_certified, dragonwell.
+- Sync JDK_HOME with JAVA_HOME
+- Update brew install commands
+- Update shell detection to use more reliable current default shell rather than shell version environment variables
+
+## [0.5.4] - 2020-08-22
+
+### Contributions
+
+- Merge pull request [#287](https://github.com/jenv/jenv/issues/287) from [pthariensflame](https://github.com/pthariensflame)/fix/sapmachine-15-ea
+- Merge pull request [#306](https://github.com/jenv/jenv/issues/306) from [voronaam](https://github.com/voronaam)/master
+- Merge pull request [#307](https://github.com/jenv/jenv/issues/307) from [roryokane](https://github.com/roryokane)/patch-3
+
+### Bug Fixes
+
+- [#188](https://github.com/jenv/jenv/issues/188) Add fish hook for prompt
+- The custom alias functionality
+
+### Documentation
+
+- Fix wrong paths in Fish install instructions
+
+### Miscellaneous Tasks
+
+- Account for changed capitalization in newest SapMachine 15 EA
+- Add fish hook for prompt
+- Refresh plugin on update
+
+## [0.5.3] - 2020-05-25
+
+### Contributions
+
+- Merge pull request [#241](https://github.com/jenv/jenv/issues/241) from [claui](https://github.com/claui)/fix-regression-in-jenv-add
+- Merge pull request [#243](https://github.com/jenv/jenv/issues/243) from [juliodias](https://github.com/juliodias)/typo
+- Merge pull request [#244](https://github.com/jenv/jenv/issues/244) from [pmairif](https://github.com/pmairif)/master
+- Merge pull request [#245](https://github.com/jenv/jenv/issues/245) from [mcsnolte](https://github.com/mcsnolte)/include_add_command_in_help
+- Merge pull request [#249](https://github.com/jenv/jenv/issues/249) from [clintropolis](https://github.com/clintropolis)/patch-1
+- Merge pull request [#255](https://github.com/jenv/jenv/issues/255) from [JenoDK](https://github.com/JenoDK)/patch-1
+- Merge pull request [#256](https://github.com/jenv/jenv/issues/256) from [smarkwell](https://github.com/smarkwell)/patch-1
+- Merge pull request [#257](https://github.com/jenv/jenv/issues/257) from [bric3](https://github.com/bric3)/fix-zsh-completions-adds-space
+- Merge pull request [#262](https://github.com/jenv/jenv/issues/262) from [danovia](https://github.com/danovia)/danovia-readme-patch
+- Merge pull request [#265](https://github.com/jenv/jenv/issues/265) from [pengisgood](https://github.com/pengisgood)/master
+- Merge pull request [#270](https://github.com/jenv/jenv/issues/270) from [tomasaschan](https://github.com/tomasaschan)/patch-1
+- Merge pull request [#271](https://github.com/jenv/jenv/issues/271) from [emcrisostomo](https://github.com/emcrisostomo)/use-precmd-hook-in-zsh-export
+- Merge pull request [#280](https://github.com/jenv/jenv/issues/280) from [pthariensflame](https://github.com/pthariensflame)/patch-1
+
+### Bug Fixes
+
+- [#193](https://github.com/jenv/jenv/issues/193) ZSH completion do not add the space anymore
+- SapMachine detection for new output style.
+- Graalvm JAVA_PROVIDER detection for jenv-add
+- Regression in `jenv add` introduced in 0617e57
+- The warn msg
+- Typo
+
+### Documentation
+
+- Correcting Github link to current README.md
+- Update README.md
+- Update README.md for fish shell
+
+### Miscellaneous Tasks
+
+- Add --verbose flag to docs
+- Add GH actions for release
+- Add Github action for release
+- Add the add command to help
+- Delete on-release.yml
+- Update jenv-add
+- Use the precmd hook instead of the chpwd hook
+- Add shortest version
+
+## [0.5.2] - 2019-02-08
+
+### Contributions
+
+- Merge pull request [#235](https://github.com/jenv/jenv/issues/235) from [bric3](https://github.com/bric3)/patch-1
+- Merge pull request [#236](https://github.com/jenv/jenv/issues/236) from [rstein66](https://github.com/rstein66)/master
+
+### Bug Fixes
+
+- [#234](https://github.com/jenv/jenv/issues/234) : install the hook within a local function
+
+### Documentation
+
+- Correct Java install command (brew -> brew cask)
+
+### Miscellaneous Tasks
+
+- Jenv doctor detect missconfigured plugin ( [#232](https://github.com/jenv/jenv/issues/232) )
+
+## [0.5.1] - 2019-01-22
+
+### Bug Fixes
+
+- [#230](https://github.com/jenv/jenv/issues/230) - jenv global regression
+
+### Miscellaneous Tasks
+
+- Avoid call on java-macos-home by default
+
+<!-- generated by git-cliff -->

changelog.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+FROM_VERSION=0.5.0
+CHANGELOG_FILE=CHANGELOG.md
+
+changelog() {
+    local opts=$@
+
+    if ! type -t git-cliff &>/dev/null
+    then
+        echo "git-cliff is required to generate the changelog" >&2
+        return 1
+    fi
+
+    if [ -z "$opts" ]
+    then
+        echo "Using default opt --bump"
+        opts="--bump"
+    fi
+
+    local changelog_details
+    changelog_details=$(git-cliff $opts "$FROM_VERSION..")
+
+    if [ -z "$changelog_details" ]
+    then
+        echo "Changelog generation failed" >&2
+        return 2
+    fi
+
+    echo "$changelog_details" | uniq > "$CHANGELOG_FILE"
+
+    echo "Changelog written to $CHANGELOG_FILE"
+}
+
+changelog "$@"

cliff.toml

@@ -0,0 +1,103 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+This file is generated by `./changelog.sh`\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits | sort(attribute="message") %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+  { pattern = '(Merge.* from )(.*?)(/.*)', replace = '${1}[${2}](https://github.com/${2})${3}' },
+  { pattern = '([ ^])#([0-9]+)([ $])', replace = '${1}[#${2}](https://github.com/jenv/jenv/issues/${2})${3}' },
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = false
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+  { pattern = '^(Merge pull request)', replace = "contribution: ${1}" },
+  { pattern = '^([^:]* .*([Rr]eadme|README).*)', replace = "doc: ${1}" },
+  { pattern = '^(.*nstall(ation)? (step?|instruction).*)', replace = "doc: ${1}" },
+  { pattern = '^[dD]oc(s?|ument) ', replace = "doc: " },
+  { pattern = '^[fF]ix(e[ds])? ', replace = "fix: " },
+  { pattern = '^[Rr]evert ', replace = "revert: " },
+  { pattern = '^[Ss]pelling:? ', replace = "misc: spelling " },
+  { pattern = '^([^ :]+) ', replace = "misc: ${1} " },
+  { pattern = '^(.*)\n(.)', replace = "${1}\n\n${2}" },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^[Cc]ontribution", group = "<!-- 0 -->Contributions" },
+  { message = "([Pp]repare|[Uu]pdate version to) \\d\\.\\d\\.\\d", skip = true },
+  { message = "^misc: Merge", skip = true },
+  { message = "^feat", group = "<!-- 1 -->Features" },
+  { message = "^fix", group = "<!-- 2 -->Bug Fixes" },
+  { message = "^doc", group = "<!-- 4 -->Documentation" },
+  { message = "^perf", group = "<!-- 5 -->Performance" },
+  { message = "^refactor", group = "<!-- 3 -->Refactor" },
+  { message = "^style", group = "<!-- 6 -->Styling" },
+  { message = "^test", group = "<!-- 7 -->Testing" },
+  #{ message = "^chore\\(deps.*\\)", skip = true },
+  #{ message = "^chore\\(pr\\)", skip = true },
+  #{ message = "^chore\\(pull\\)", skip = true },
+  #{ message = "^chore|^ci", group = "<!-- 8 --> Miscellaneous Tasks" },
+  { message = "^misc", group = "<!-- 8 --> Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 9 -->Security" },
+  { message = "^revert", group = "<!-- 10 --> Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+tag_pattern = "\\d\\.\\d\\.\\d"
+# regex for skipping tags
+# skip_tags = ""
+# regex for ignoring tags
+# ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42