Merge branch 'release/0.2' into develop

.gitlab-ci.yml

@@ -18,6 +18,7 @@ include:
       - '/templates/check-license.yaml'
       - '/templates/generate-sbom-cyclonedx.yaml'
       - 'templates/deploy-packagecloud.yaml'
+      - 'templates/release-marker.yaml'
   - template: Security/SAST.gitlab-ci.yml
   - template: Security/Dependency-Scanning.gitlab-ci.yml
   - template: Security/Secret-Detection.gitlab-ci.yml

.semver-version

@@ -1 +1 @@
-0.2.0
+0.3.0-alpha.1

CHANGELOG-0.2.1.adoc

@@ -0,0 +1,27 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+== [0.2.1-rc.1] - 2024-03-04
+
+=== Changed
+
+- Update CI pipeline to v0.1.20
+- Switch from log to tracing
+- Create Kubernetes CLI tool to inspect a cluster
+- Add CLI to query Longhorn
+- Update dependencies
+- Regenerate stubs with latest dependency
+
+=== Fixed
+
+- Update CI pipeline to reflect latest changes
+
+=== Removed
+
+- Remove sec-audit due to no longer maintained
+
+[0.2.1-rc.1]: https://gitlab.com/ds_2/n8w8-rust-fe/compare?from=v0.1.1-rc.1&to=v0.2.1-rc.1

CHANGELOG-0.2.1.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.1-rc.1] - 2024-03-04
+
+### Changed
+
+- Update CI pipeline to v0.1.20
+- Switch from log to tracing
+- Create Kubernetes CLI tool to inspect a cluster
+- Add CLI to query Longhorn
+- Update dependencies
+- Regenerate stubs with latest dependency
+
+### Fixed
+
+- Update CI pipeline to reflect latest changes
+
+### Removed
+
+- Remove sec-audit due to no longer maintained
+
+[0.2.1-rc.1]: https://github.com///compare/v0.1.1-rc.1..v0.2.1-rc.1
+
+<!-- generated by git-cliff -->

CHANGELOG-0.3.0-alpha.1.adoc

@@ -0,0 +1,23 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+== [0.2.1] - 2024-03-04
+
+=== Added
+
+- Add release marker
+- Add newline to changelog footer
+
+=== Changed
+
+- Update changelog
+- Update docs
+- Change the way how updates are notified
+- Update docs
+- The n8w8d package became the nachtwacht-agent package
+
+[0.2.1]: https://gitlab.com/ds_2/n8w8-rust-fe/compare?from=v0.2.1-rc.1&to=v0.2.1

CHANGELOG-0.3.0-alpha.1.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.1] - 2024-03-04
+
+### Added
+
+- Add release marker
+- Add newline to changelog footer
+
+### Changed
+
+- Update changelog
+- Update docs
+- Change the way how updates are notified
+- Update docs
+- The n8w8d package became the nachtwacht-agent package
+
+[0.2.1]: https://github.com///compare/v0.2.1-rc.1..v0.2.1
+
+<!-- generated by git-cliff -->

CHANGELOG.adoc

@@ -0,0 +1,27 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+== [0.2.1-rc.1] - 2024-03-04
+
+=== Changed
+
+- Update CI pipeline to v0.1.20
+- Switch from log to tracing
+- Create Kubernetes CLI tool to inspect a cluster
+- Add CLI to query Longhorn
+- Update dependencies
+- Regenerate stubs with latest dependency
+
+=== Fixed
+
+- Update CI pipeline to reflect latest changes
+
+=== Removed
+
+- Remove sec-audit due to no longer maintained
+
+[0.2.1-rc.1]: https://gitlab.com/ds_2/n8w8-rust-fe/compare?from=v0.1.1-rc.1&to=v0.2.1-rc.1

CONTRIBUTING.adoc

@@ -0,0 +1,10 @@
+= Contributing
+:toc:
+
+Here we discuss the build process, ci process and release process.
+
+include::docs/building.adoc[leveloffset=+1]
+include::docs/container.adoc[leveloffset=+1]
+include::docs/testing.adoc[leveloffset=+1]
+
+include::docs/releasing.adoc[leveloffset=+1]

README.adoc

@@ -1,5 +1,7 @@
 = Nachtwacht (N8w8) Rust Implementations
 Author Dirk Strauss <author@email.org>
+:toc:
+:toclevels: 3
 
 image:https://gitlab.com/ds_2/n8w8-rust-fe/badges/main/pipeline.svg[Static,100,link="https://gitlab.com/ds_2/n8w8-rust-fe/-/commits/main",title="pipeline status"]
 image:https://gitlab.com/ds_2/n8w8-rust-fe/-/badges/release.svg[Static,100,link="https://gitlab.com/ds_2/n8w8-rust-fe/-/releases",title="Latest Release"]
@@ -8,35 +10,14 @@ image:https://gitlab.com/ds_2/n8w8-rust-fe/-/badges/release.svg[Static,100,link=
 [.lead]
 This project contains all subprojects to perform the n8w8 tests.
 
-:toc:
 
 == The name
 
 _Nachtwacht_ is the german name for _nightwatch_. It comes from the people
 who were watching over a city at night. Similar to what DevOps people
 are doing nowadays with servers and clouds during the night.
 
-include::docs/env.adoc[leveloffset=1]
-
-include::docs/building.adoc[]
-
-include::docs/testing.adoc[]
-
-include::docs/container.adoc[]
-
-include::executor/README.adoc[]
-
-include::docs/releasing.adoc[]
-include::agent/Create-RPM.adoc[]
-include::agent/Create-Debian.adoc[]
-
-== Documentation
-
-You can start the local doc server via:
-
-[,shell]
-----
-cargo doc --open
-----
+include::CHANGELOG.adoc[leveloffset=+1]
 
-This will open your default browser with the documentation of the project.
+include::docs/usage.adoc[leveloffset=+1]
+include::CONTRIBUTING.adoc[leveloffset=+1]

agent/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "n8w8d"
-version = "0.2.0"
+version = "0.3.0-alpha.1"
 edition = "2021"
 license = "GPLv3"
 description = "A host service to retrieve local health data and send it to N8w8"

agent/Create-Debian.adoc

@@ -1,4 +1,4 @@
-== Create Debian Image
+= Create Debian Image
 
 To create a deb file we need to create a release first:
 

agent/Create-RPM.adoc

@@ -1,4 +1,4 @@
-== Creating RPMs
+= Creating RPMs
 
 To create an rpm of the agent, install some tools before:
 

checks/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nachtwacht-checks"
-version = "0.2.0"
+version = "0.3.0-alpha.1"
 edition = "2021"
 license = "GPLv3"
 description = "This package contains the implementations for all tests."

cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nachtwacht-cli"
-version = "0.2.0"
+version = "0.3.0-alpha.1"
 edition = "2021"
 license = "GPLv3"
 description = "This package contains all the client binaries to run some tests alone without the server."

cliff.toml

@@ -0,0 +1,77 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+[changelog]
+# changelog header
+header = """
+= Changelog\n
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\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 | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+{% for release in releases -%}
+    {% if release.version -%}
+        {% if release.previous.version -%}
+            [{{ release.version | trim_start_matches(pat="v") }}]: \
+                https://gitlab.com/ds_2/n8w8-rust-fe\
+                    /compare?from={{ release.previous.version }}&to={{ release.version }}
+        {% endif -%}
+    {% else -%}
+        [unreleased]: https://gitlab.com/ds_2/n8w8-rust-fe\
+            /compare?from={{ release.previous.version }}&to=HEAD
+    {% endif -%}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^.*: add", group = "Added" },
+  { message = "^.*: support", group = "Added" },
+  { message = "^.*: remove", group = "Removed" },
+  { message = "^.*: delete", group = "Removed" },
+  { message = "^test", group = "Fixed" },
+  { message = "^fix", group = "Fixed" },
+  { message = "^.*: fix", group = "Fixed" },
+  { message = "^.*", group = "Changed" },
+]
+# 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 = true
+# regex for matching git tags
+tag_pattern = "v[0-9].*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"
+# 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"