feat: Update README install instructions and CHANGELOG

#!make

.PHONY: $(TASKS)

-include .env

clean:

	@rm -rf ./bin

	@cargo clean

changelog:

	@git pull origin main --tags

	@git-cliff --output CHANGELOG.md --gitlab-token ${GITLAB_TOKEN}

coverage: clean lint

	@cargo tarpaulin --out lcov --line --skip-clean --no-dead-code --engine llvm --lib

### Download pre-compiled binary

- Download newest binary from [releases page](https://code.ornl.gov/research-enablement/xylem/-/releases)

    ```shell

    curl -LO https://code.ornl.gov/api/v4/projects/15383/packages/generic/x86_64-unknown-linux-gnu/v0.0.10/xylem

    curl -LO https://code.ornl.gov/api/v4/projects/15383/packages/generic/x86_64-unknown-linux-musl/v0.0.11/xylem

    ```

- Make binary executable

    ```shell

# 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.

[remote.gitlab]

owner = "research-enablement"

repo = "xylem"

api_url = "https://code.ornl.gov/api/v4"

[changelog]

# template for the changelog header

header = """

# Changelog\n

All notable changes to this project will be documented in this file.\n

"""

# template for the changelog body

# https://keats.github.io/tera/docs/#introduction

# A Tera template to be rendered as the changelog's header.

# See https://keats.github.io/tera/docs/#introduction

header = """# CHANGELOG 🌱\n> Wisdom is knowledge of things that don't change, intelligence is the knowledge of things that do\n\n"""

# A Tera template to be rendered for each release in the changelog.

# See https://keats.github.io/tera/docs/#introduction

body = """

{%- macro remote_url() -%}

  https://code.ornl.gov/{{ remote.gitlab.owner }}/{{ remote.gitlab.repo }}

{%- endmacro -%}

{% macro print_commit(commit) -%}

    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\

        {% if commit.breaking %}[**breaking**] {% endif %}\

        {{ commit.message | upper_first }} - \

        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\

{% endmacro -%}

{% if version %}\

    {% if previous.version %}\

        ## [{{ version | trim_start_matches(pat="v") }}]\

          ({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}

    {% else %}\

        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}

    {% endif %}\

{% else %}\

    ## [unreleased]

    ## Unreleased

    > ⚠️ If you want to use these changes, you will need to build from source. Consult [CONTRIBUTING.md](<REPO>/-/blob/main/CONTRIBUTING.md) for details.

{% endif %}\

{% for group, commits in commits | group_by(attribute="group") %}

    ### {{ group | striptags | trim | upper_first }}

    {% for commit in commits

    | filter(attribute="scope")

    | sort(attribute="scope") %}

        {{ self::print_commit(commit=commit) }}

    {%- endfor %}

    {% for commit in commits %}

        - {% 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 -->

        {%- if not commit.scope -%}

            {{ self::print_commit(commit=commit) }}

        {% endif -%}

    {% endfor -%}

{% endfor -%}

"""

# remove the leading and trailing s

# A Tera template to be rendered as the changelog's footer.

# See https://keats.github.io/tera/docs/#introduction

footer = """"""

# Remove leading and trailing whitespaces from the changelog's body.

trim = true

# postprocessors

# An array of regex based postprocessors to modify the changelog.

postprocessors = [

  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL

  # Replace the placeholder `<REPO>` with a URL.

  { pattern = '<REPO>', replace = "https://code.ornl.gov/research-enablement/xylem" }, # replace repository URL

]

# render body even when there are no releases to process

# render_always = true

# output file path

# output = "test.md"

[git]

# parse the commits based on https://www.conventionalcommits.org

# Parse commits according to the conventional commits specification.

# See https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

# Exclude commits that do not match the conventional commits specification.

filter_unconventional = true

# process each line of a commit as an individual commit

# Split commits on newlines, treating each line as an individual commit.

split_commits = false

# regex for preprocessing the commit messages

# An array of regex based parsers to modify commit messages prior to further processing.

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 -' },

  # Replace issue numbers with link templates to be updated in `changelog.postprocessors`.

  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" },

  # Check spelling of the commit message using https://github.com/crate-ci/typos.

  # If the spelling is incorrect, it will be fixed automatically.

  { pattern = '.*', replace_command = 'typos --write-changes -' },

]

# regex for parsing and grouping commits

# An array of regex based parsers for extracting data from the commit message.

# Assigns commits to groups.

# Optionally sets the commit's scope and can decide to exclude commits from further processing.

commit_parsers = [

  { message = "^feat", group = "<!-- 0 -->🚀 Features" },

  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },

  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },

  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },

  { message = "^refactor\\(clippy\\)", skip = true },

  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },

  { message = "^style", group = "<!-- 5 -->🎨 Styling" },

  { message = "^test", group = "<!-- 6 -->🧪 Testing" },

  { message = "^chore\\(release\\): prepare for", skip = true },

  { message = "^chore\\(deps.*\\)", skip = true },

  { message = "^chore\\(pr\\)", skip = true },

  { message = "^chore\\(pull\\)", skip = true },

  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },

  { message = "^chore", skip = true },

  { message = "^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },

  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },

  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },

  { message = "^wip", group = "<!-- 9 -->🚧 In Progress" },

  { message = "^dev", group = "<!-- 9 -->🤓 Developer Experience" },

]

# filter out the commits that are not matched by commit parsers

# Prevent commits that are breaking from being excluded by commit parsers.

protect_breaking_commits = false

# Exclude commits that are not matched by any commit parser.

filter_commits = false

# sort the tags topologically

# Regex to select git tags that represent releases.

tag_pattern = "v[0-9].*"

# Regex to select git tags that do not represent proper releases.

# Takes precedence over `tag_pattern`.

# Changes belonging to these releases will be included in the next release.

skip_tags = "beta|alpha"

# Regex to exclude git tags after applying the tag_pattern.

ignore_tags = "rc|v2.1.0|v2.1.1"

# Order releases topologically instead of chronologically.

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "oldest"

# Order of commits in each group/release within the changelog.

# Allowed values: newest, oldest

sort_commits = "newest"

 No newline at end of file