fullstack-devops · eksrha · Feb 18, 2025 · Feb 17, 2025 · Feb 17, 2025 · Feb 18, 2025
diff --git a/LICENSE b/LICENSE
@@ -186,7 +186,7 @@ APPENDIX: How to apply the Apache License to your work.
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-Copyright [2022] [eksrha]
+Copyright [2025] [Eike Haller]
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 # Awesome CI
 
-**Description**: This project is the smart connection between your pipeline for continuous integration and your version management like GitLab or GitHub. The focus is on the release process, followed by the version management of [SemVer](https://semver.org/). The required version number is created with the correct naming of the branch prefix.
+**Description**: Awesome CI is the smart connection between your pipeline for continuous integration and GitHub. The focus is on the release process, followed by the version management of [SemVer](https://semver.org/). The required version number is created with the correct naming of the branch prefix.
 
 - **Technology stack**: This tool is written in golang
 - **Status**: Stable.
@@ -19,43 +19,41 @@
   - Jenkins Pipelines
 - **Sweet Spot**: If you use GitHub or GitHub Enterprise and GitHub Actions, you can use awesome-ci to its full potential!
 
-**ToDos**:
+## Getting Started
 
-- more documentation
-- more tests (at least 80% coverage)
-- implement GitLab Api
-
-> Info: GitLab is currently not supported
+You can use this tool in your CI pipeline or locally on your command line. Just [download](https://github.com/fullstack-devops/awesome-ci/releases/latest/download/awesome-ci) the most recently released version and get started.
 
 ## Usage
 
-You can use this tool in your CI pipeline or locally on your command line. Just [download](https://github.com/fullstack-devops/awesome-ci/releases/latest/download/awesome-ci) the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the [examples section](https://fullstack-devops.github.io/awesome-ci/docs/examples) of the documentation. If an example is not included, please feel free to inquire about a related [issue](https://github.com/fullstack-devops/awesome-ci/issues/new/choose).
+To integrate Awesome CI into your pipeline, follow these steps:
 
-If more functionality is needed you can just open a problem in this project and of course bugs can be fixed in the same way by filing a [bug report](https://github.com/fullstack-devops/awesome-ci/issues/new/choose).
+1. Utilize the github action [fullstack-devops/awesome-ci-action](https://github.com/fullstack-devops/awesome-ci-action) to install Awesome CI.
+2. Configure your pipeline to use Awesome CI.
+3. Use the any command to interact with Awesome CI.
 
-If you have any questions, you can find a form on the issue board. First, make sure your question is already in the [Questions and Answers](https://fullstack-devops.github.io/awesome-ci/docs/questions_and_answers) section before asking a question. You can find frequently asked questions there too.
+You can find more information on how to integrate Awesome CI into your pipeline in the [manual](https://fullstack-devops.github.io/awesome-ci/).
 
-## Documentation
+## Examples
 
-[See the manual](https://fullstack-devops.github.io/awesome-ci/) for setup, usage instructions and a lot more. (the documentation is still rising)
+You can find several examples of how to use Awesome CI in the [examples section](https://fullstack-devops.github.io/awesome-ci/docs/examples) of the documentation.
 
-## Getting help
+## Frequently Asked Questions
 
-If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
-You can find frequently asked questions directly in the "Questions and Answers" section.
+You can find frequently asked questions in the [Questions and Answers](https://fullstack-devops.github.io/awesome-ci/docs/questions_and_answers) section of the documentation.
 
-## Getting involved
+## Getting Help
 
-- [CONTRIBUTING](docs/CONTRIBUTING.md)
+If you have questions, concerns, or bug reports, please file an issue in this repository's Issue Tracker.
 
----
+## Contributing
 
-## Open source licensing info
+If you want to contribute to Awesome CI, please read the [CONTRIBUTING](docs/CONTRIBUTING.md) guide.
 
-1. [LICENSE](LICENSE)
+## License
 
----
+Awesome CI is licensed under the Apache License, Version 2.0. You can find the license file [here](LICENSE).
 
-## Credits and references
+## Credits
 
 - [SemVer](https://semver.org/)
+- [Cobra CLI](https://github.com/spf13/cobra)
diff --git a/docs/docs/01-overview.md b/docs/docs/01-overview.md
@@ -4,7 +4,7 @@ title: Overview
 
 # Welcome to the Awesome CI!
 
-This project is the smart connection between your pipeline for continuous integration and your version management like GitLab or GitHub. The focus is on the release process, followed by the version management of SemVer. The required version number is created with the correct naming of the branch prefix.
+This project is the smart connection between your pipeline for continuous integration and your version management like GitHub. The focus is on the release process, followed by the version management of SemVer. The required version number is created with the correct naming of the branch prefix.
 
 You can use this tool in your CI pipeline or locally on your command line. Just download the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the examples section of the documentation. If an example is not included, please feel free to inquire about a related issue.
 
@@ -23,7 +23,7 @@ If you need an example for your pipeline you can find it in the sidebar under th
 
 :::
 
-### Supported naming rules and effects on the version
+## Supported naming rules and effects on the version
 
 The patching of the version only takes effect if the merged branch begins with the following aliases, for example: `feature/my-awesome-feature`
 
@@ -41,22 +41,27 @@ The tailing `/` behind the alias is **always** requiered!
 see also [override specialties](#override-specialties)
 :::
 
-![awesome-ci release process](/img-awesome-ci/release-process.drawio.svg "awesome-ci release process")
-![awesome-ci workflow](/img-awesome-ci/aci-workflow.drawio.png "awesome-ci workflow")
+![awesome-ci release process](/img/release-process.drawio.svg "awesome-ci release process")
+![awesome-ci workflow](/img/aci-workflow.drawio.png "awesome-ci workflow")
 
 :::tip
-Awesoce CI automatically detects your environment. Supported are **Jenkins**, **GitHub Actions** and ~~GitLab CI~~
+Awesoce CI automatically detects your environment. Supported are **Jenkins Pipelines** and **GitHub Actions**
 :::
 
-### Override specialties
+## Override specialties
 
 To set some attributes during developement you can comment a pullrequest.
 
-### Requiered and optional environment variables
+| command                       | description                                                   |
+| ----------------------------- | ------------------------------------------------------------- |
+| `aci_patch_level: major`      | create a major version bump                                   |
+| `aci_version_override: 2.1.0` | set the version to 2.1.0 using only semver compatible syntax! |
+
+## Requiered and optional environment variables
 
 List of all environmental variables used per CES (code execution service).
 
-#### GitHub Actions
+### GitHub Actions
 
 | Environment variable | Description                                        | Status        | Requiered |
 | -------------------- | -------------------------------------------------- | ------------- | :-------: |
@@ -65,16 +70,7 @@ List of all environmental variables used per CES (code execution service).
 | `GITHUB_REPOSITORY`  | The owner and repository name.                     | set by runner |   true    |
 | `GITHUB_TOKEN`       | Must provided in workflow as `env:` (see examples) | set by runner |   true    |
 
-#### GitLab Workflows
-
-| Environment variable | Description                                                    | Status        | requiered |
-| -------------------- | -------------------------------------------------------------- | ------------- | :-------: |
-| `CI`                 | Is set by GitLab Workflows and returns `true`                  | set by runner |   true    |
-| `CI_SERVER_URL`      | Will only be set by using the GitHub Plugin.                   | set by runner |   true    |
-| `CI_PROJECT_URL`     | The owner and repository name.                                 | set by runner |   true    |
-| `CI_JOB_TOKEN`       | Must provided in pipeline as `env.GITHUB_TOKEN` (see examples) | set by runner |   true    |
-
-#### Jenkins Pipeline
+### Jenkins Pipeline
 
 | Environment variable | Description                                                    | Status                       | requiered |
 | -------------------- | -------------------------------------------------------------- | ---------------------------- | :-------: |

diff --git a/docs/docs/02-cli/awesome-ci.md → docs/docs/02-CLI/awesome-ci.md b/docs/docs/02-cli/awesome-ci.md → docs/docs/02-CLI/awesome-ci.md
@@ -30,4 +30,4 @@ awesome-ci [flags]
 * [awesome-ci release](./awesome-ci_release)	 - Manage GitHub releases with ease
 * [awesome-ci transform](./awesome-ci_transform)	 - transform given input to json
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_connect.md → docs/docs/02-CLI/awesome-ci_connect.md b/docs/docs/02-cli/awesome-ci_connect.md → docs/docs/02-CLI/awesome-ci_connect.md
@@ -35,4 +35,4 @@ awesome-ci connect [flags]
 * [awesome-ci connect github](./awesome-ci_connect_github)	 - connect initial to a GitHub or GitHub Enterprise
 * [awesome-ci connect remove](./awesome-ci_connect_remove)	 - remove all persisted connection files and secrets
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_connect_check.md → docs/docs/02-CLI/awesome-ci_connect_check.md b/docs/docs/02-cli/awesome-ci_connect_check.md → docs/docs/02-CLI/awesome-ci_connect_check.md
@@ -25,4 +25,4 @@ awesome-ci connect check [flags]
 
 * [awesome-ci connect](./awesome-ci_connect)	 - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/.../docs/02-cli/awesome-ci_connect_github.md → .../docs/02-CLI/awesome-ci_connect_github.md b/.../docs/02-cli/awesome-ci_connect_github.md → .../docs/02-CLI/awesome-ci_connect_github.md
@@ -28,4 +28,4 @@ awesome-ci connect github [flags]
 
 * [awesome-ci connect](./awesome-ci_connect)	 - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/.../docs/02-cli/awesome-ci_connect_remove.md → .../docs/02-CLI/awesome-ci_connect_remove.md b/.../docs/02-cli/awesome-ci_connect_remove.md → .../docs/02-CLI/awesome-ci_connect_remove.md
@@ -25,4 +25,4 @@ awesome-ci connect remove [flags]
 
 * [awesome-ci connect](./awesome-ci_connect)	 - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_parse.md → docs/docs/02-CLI/awesome-ci_parse.md b/docs/docs/02-cli/awesome-ci_parse.md → docs/docs/02-CLI/awesome-ci_parse.md
@@ -28,4 +28,4 @@ awesome-ci parse [flags]
 * [awesome-ci parse version](./awesome-ci_parse_version)	 - Validate the given version string against semver syntax
 * [awesome-ci parse yaml](./awesome-ci_parse_yaml)	 - parse a yaml string or file
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_parse_json.md → docs/docs/02-CLI/awesome-ci_parse_json.md b/docs/docs/02-cli/awesome-ci_parse_json.md → docs/docs/02-CLI/awesome-ci_parse_json.md
@@ -28,4 +28,4 @@ awesome-ci parse json [flags]
 
 * [awesome-ci parse](./awesome-ci_parse)	 - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_parse_version.md → docs/docs/02-CLI/awesome-ci_parse_version.md b/docs/docs/02-cli/awesome-ci_parse_version.md → docs/docs/02-CLI/awesome-ci_parse_version.md
@@ -25,4 +25,4 @@ awesome-ci parse version [flags]
 
 * [awesome-ci parse](./awesome-ci_parse)	 - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_parse_yaml.md → docs/docs/02-CLI/awesome-ci_parse_yaml.md b/docs/docs/02-cli/awesome-ci_parse_yaml.md → docs/docs/02-CLI/awesome-ci_parse_yaml.md
@@ -28,4 +28,4 @@ awesome-ci parse yaml [flags]
 
 * [awesome-ci parse](./awesome-ci_parse)	 - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_pr.md → docs/docs/02-CLI/awesome-ci_pr.md b/docs/docs/02-cli/awesome-ci_pr.md → docs/docs/02-CLI/awesome-ci_pr.md
@@ -30,4 +30,4 @@ awesome-ci pr [flags]
 * [awesome-ci](./awesome-ci)	 - Awesome CI make your release tagging easy
 * [awesome-ci pr info](./awesome-ci_pr_info)	 - Get pull request info
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_pr_info.md → docs/docs/02-CLI/awesome-ci_pr_info.md b/docs/docs/02-cli/awesome-ci_pr_info.md → docs/docs/02-CLI/awesome-ci_pr_info.md
@@ -27,4 +27,4 @@ awesome-ci pr info [flags]
 
 * [awesome-ci pr](./awesome-ci_pr)	 - Manage GitHub pull requests
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_release.md → docs/docs/02-CLI/awesome-ci_release.md b/docs/docs/02-cli/awesome-ci_release.md → docs/docs/02-CLI/awesome-ci_release.md
@@ -40,4 +40,4 @@ awesome-ci release [flags]
 * [awesome-ci release create](./awesome-ci_release_create)	 - Create a new GitHub release
 * [awesome-ci release publish](./awesome-ci_release_publish)	 - Publish a recently created GitHub release
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/.../docs/02-cli/awesome-ci_release_create.md → .../docs/02-CLI/awesome-ci_release_create.md b/.../docs/02-cli/awesome-ci_release_create.md → .../docs/02-CLI/awesome-ci_release_create.md
@@ -34,4 +34,4 @@ awesome-ci release create [flags]
 
 * [awesome-ci release](./awesome-ci_release)	 - Manage GitHub releases with ease
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/...docs/02-cli/awesome-ci_release_publish.md → ...docs/02-CLI/awesome-ci_release_publish.md b/...docs/02-cli/awesome-ci_release_publish.md → ...docs/02-CLI/awesome-ci_release_publish.md
@@ -36,4 +36,4 @@ awesome-ci release publish [flags]
 
 * [awesome-ci release](./awesome-ci_release)	 - Manage GitHub releases with ease
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_transform.md → docs/docs/02-CLI/awesome-ci_transform.md b/docs/docs/02-cli/awesome-ci_transform.md → docs/docs/02-CLI/awesome-ci_transform.md
@@ -26,4 +26,4 @@ awesome-ci transform [flags]
 * [awesome-ci](./awesome-ci)	 - Awesome CI make your release tagging easy
 * [awesome-ci transform group-by](./awesome-ci_transform_group-by)	 - group string array by prefix to json
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/...s/02-cli/awesome-ci_transform_group-by.md → ...s/02-CLI/awesome-ci_transform_group-by.md b/...s/02-cli/awesome-ci_transform_group-by.md → ...s/02-CLI/awesome-ci_transform_group-by.md
@@ -34,4 +34,4 @@ awesome-ci tf group-by -p 3 --sub-prefix 4 st1_infrastructure-base  st2_ubi9-ope
 
 * [awesome-ci transform](./awesome-ci_transform)	 - transform given input to json
 
-###### Auto generated by spf13/cobra on 5-Dec-2024
+###### Auto generated by spf13/cobra on 17-Feb-2025
diff --git a/docs/docs/02-cli/awesome-ci_version.md → docs/docs/02-CLI/awesome-ci_version.md b/docs/docs/02-cli/awesome-ci_version.md → docs/docs/02-CLI/awesome-ci_version.md
diff --git a/docs/docs/02-cli/_category_.yaml b/docs/docs/02-cli/_category_.yaml
diff --git a/docs/docs/03-examples/_category_.yaml b/docs/docs/03-examples/_category_.yaml
diff --git a/docs/docs/05-contributing.md b/docs/docs/05-contributing.md
@@ -28,7 +28,7 @@ Please note we have a code of conduct, please follow it in all your interactions
 
 ### Abstraction of layers
 
-![Abstraction of layers](/img-awesome-ci/layers.svg)
+![Abstraction of layers](/img/layers.svg)
 
 ## Code of Conduct
 

diff --git a/docs/docs/_category_.yaml b/docs/docs/_category_.yaml
diff --git a/docs/package.json b/docs/package.json
@@ -15,9 +15,9 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.3.2",
-    "@docusaurus/preset-classic": "^3.3.2",
-    "@docusaurus/theme-mermaid": "^3.3.2",
+    "@docusaurus/core": "^3.7.0",
+    "@docusaurus/preset-classic": "^3.7.0",
+    "@docusaurus/theme-mermaid": "^3.7.0",
     "@mdx-js/react": "^3.0.1",
     "clsx": "^2.1.1",
     "docusaurus-lunr-search": "^3.4.0",
@@ -26,9 +26,9 @@
     "react-dom": "^18.3.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.3.2",
-    "@docusaurus/tsconfig": "^3.3.2",
-    "@docusaurus/types": "^3.3.2",
+    "@docusaurus/module-type-aliases": "^3.7.0",
+    "@docusaurus/tsconfig": "^3.7.0",
+    "@docusaurus/types": "^3.7.0",
     "@tsconfig/docusaurus": "^2.0.3",
     "typescript": "^5.4.5"
   },

diff --git a/...ic/img-awesome-ci/aci-workflow.drawio.png → docs/static/img/aci-workflow.drawio.png b/...ic/img-awesome-ci/aci-workflow.drawio.png → docs/static/img/aci-workflow.drawio.png
diff --git a/docs/static/img-awesome-ci/layers.svg → docs/static/img/layers.svg b/docs/static/img-awesome-ci/layers.svg → docs/static/img/layers.svg
diff --git a/.../img-awesome-ci/release-assets-readme.png → docs/static/img/release-assets-readme.png b/.../img-awesome-ci/release-assets-readme.png → docs/static/img/release-assets-readme.png
diff --git a/...img-awesome-ci/release-process.drawio.svg → docs/static/img/release-process.drawio.svg b/...img-awesome-ci/release-process.drawio.svg → docs/static/img/release-process.drawio.svg
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,4 +25,4 @@ awesome-ci connect check [flags]

		* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,4 +28,4 @@ awesome-ci connect github [flags]

		* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,4 +25,4 @@ awesome-ci connect remove [flags]

		* [awesome-ci connect](./awesome-ci_connect) - Create an encrypted .rc file to persistently connect to GitHub or GitHub Enterprise

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,4 +28,4 @@ awesome-ci parse json [flags]

		* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,4 +25,4 @@ awesome-ci parse version [flags]

		* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,4 +28,4 @@ awesome-ci parse yaml [flags]

		* [awesome-ci parse](./awesome-ci_parse) - inspect and parse JSON and YAML files to retrieve values, similar to jq with additional features

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,4 +27,4 @@ awesome-ci pr info [flags]

		* [awesome-ci pr](./awesome-ci_pr) - Manage GitHub pull requests

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ awesome-ci release create [flags]

		* [awesome-ci release](./awesome-ci_release) - Manage GitHub releases with ease

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,4 @@ awesome-ci release publish [flags]

		* [awesome-ci release](./awesome-ci_release) - Manage GitHub releases with ease

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ awesome-ci tf group-by -p 3 --sub-prefix 4 st1_infrastructure-base st2_ubi9-ope

		* [awesome-ci transform](./awesome-ci_transform) - transform given input to json

		###### Auto generated by spf13/cobra on 5-Dec-2024
		###### Auto generated by spf13/cobra on 17-Feb-2025