diff --git a/.github/CONTRIBUTING.md b/CONTRIBUTING.md
similarity index 100%
rename from .github/CONTRIBUTING.md
rename to CONTRIBUTING.md
diff --git a/.github/PUBLISHING.md b/PUBLISHING.md
similarity index 73%
rename from .github/PUBLISHING.md
rename to PUBLISHING.md
index dc23d824..736cc8ea 100644
--- a/.github/PUBLISHING.md
+++ b/PUBLISHING.md
@@ -4,7 +4,7 @@ This page describes how to publish a new version of plugin and all related artif
Steps:
-1. Create a PR with version increment in [gradle.properties](../gradle.properties) and in [documentation](../README.adoc). Please follow [semver guidelines](https://semver.org/):
+1. Create a PR with version increment in [gradle.properties](./gradle.properties) and in [documentation](./README.md). Please follow [semver guidelines](https://semver.org/):
1. If there are breaking `.api` files - increment the major version (e.g. from `x.y.z` to `x+1.0.0`)
2. If current version is compatible with previous one and there are some notable changes - please increment the minor one (e.g. from `x.y.z` to `x.y+1.0`)
3. Otherwise - please increment the patch version (e.g. from `x.y.z` to `x.y.z+1`).
@@ -12,7 +12,7 @@ Steps:
follow [the documentation](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html)) and add them into the project secrets.
3. Run publication workflows:
1. Navigate to [Actions](https://github.com/Citi/gradle-helm-plugin/actions/workflows/) and locate
- the [publish workflow](./workflows/publish.yaml) and [publish documentation one](./workflows/publish.yaml). GitHub
+ the [publish workflow](./.github/workflows/publish.yaml) and [publish documentation one](./.github/workflows/publish.yaml). GitHub
documentation: https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow
2. Run both workflows
-4. Release [the version on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github).
\ No newline at end of file
+4. Release [the version on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github).
diff --git a/README.adoc b/README.adoc
deleted file mode 100644
index 8e0ce654..00000000
--- a/README.adoc
+++ /dev/null
@@ -1,73 +0,0 @@
-ifdef::env-github[]
-:tip-caption: :bulb:
-:note-caption: :information_source:
-:important-caption: :heavy_exclamation_mark:
-:caution-caption: :fire:
-:warning-caption: :warning:
-endif::[]
-
-= Gradle Helm Plugin
-:version: 2.1.0
-:pluginId: com.citi.helm
-
-image:https://img.shields.io/gradle-plugin-portal/v/{pluginId}?versionPrefix={version}[link=https://plugins.gradle.org/plugin/{pluginId}/{version}]
-
-This is a suite of Gradle plugins for building, publishing and managing https://www.helm.sh/[Helm] charts.
-
-
-== Features
-
-* Gradle task types for common Helm CLI commands
-* Build, package and publish Helm charts using a declarative Gradle DSL
-* Resolve placeholders like `$\{chartVersion}` from chart source files before packaging
-* Resolve dependencies between charts using Gradle artifact dependencies
-* Install, upgrade and uninstall releases to/from a Kubernetes cluster
-
-
-== Requirements
-
-* Gradle 7 or higher
-* JDK 1.8 or higher (for running Gradle)
-* Helm command-line client 3.+
-
-
-== Quick Start
-
-Apply the `{pluginId}` plugin to your Gradle project:
-
-.build.gradle
-[source,groovy,subs="attributes"]
-----
-plugins {
- id '{pluginId}' version '{version}'
-}
-----
-
-.build.gradle.kts
-[source,kotlin,subs="attributes"]
-----
-plugins {
- id("{pluginId}") version "{version}"
-}
-----
-
-
-Put your Helm chart sources into `src/main/helm`:
-
-----
-📂 (project root)
- 📂 src
- 📂 main
- 📂 helm
- 📂 templates
- 📄 ...
- 📄 Chart.yaml
- 📄 values.yaml
-----
-
-Use the `helmPackage` task to build your chart.
-
-
-== Further Documentation
-
-* https://citi.github.io/gradle-helm-plugin/[User Manual]
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..6f6eefe4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,92 @@
+
+ A suite of Gradle Plugins for building, publishing and managing Helm Charts
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Features
+
+- Gradle task types for common Helm CLI commands
+
+- Build, package and publish Helm Charts using a declarative Gradle DSL
+
+- Resolve placeholders like ${chartVersion} from chart source files before packaging
+
+- Resolve dependencies between charts using Gradle artifact dependencies
+
+- Install, upgrade and uninstall releases to/from a Kubernetes cluster
+
+## Quick Start
+
+Add `com.citi.helm` to your Gradle project:
+
+```gradle
+plugins {
+ id 'com.citi.helm' version '2.1.0'
+}
+```
+
+```gradle
+plugins {
+ id("com.citi.helm") version "2.1.0"
+}
+```
+
+```gradle
+📂 (project root)
+ 📂 src
+ 📂 main
+ 📂 helm
+ 📂 templates
+ 📄 ...
+ 📄 Chart.yaml
+ 📄 values.yaml
+```
+
+## Requirements
+
+- Gradle 7 or higher
+
+- JDK 1.8 or higher (for running Gradle)
+
+- Helm command-line client 3.+
+
+## Contributing
+
+Your contributions are at the core of making this a true open source project. Any contributions you make are **greatly appreciated**.
+
+We welcome you to:
+
+- Fix typos or touch up documentation
+- Share your opinions on [existing issues](https://github.com/citi/gradle-helm-plugin/issues)
+- Help expand and improve our library by [opening a new issue](https://github.com/citi/gradle-helm-plugin/issues/new)
+
+Please review our [community contribution guidelines](https://github.com/Citi/.github/blob/main/CONTRIBUTING.md) and [functional contribution guidelines](./CONTRIBUTING.md) to get started 👍
+
+## Code of Conduct
+
+We are committed to making open source an enjoyable and respectful experience for our community. See [`CODE_OF_CONDUCT`](https://github.com/Citi/.github/blob/main/CODE_OF_CONDUCT.md) for more information.
+
+## License
+
+This project is distributed under the [MIT License](https://opensource.org/license/mit). See [`LICENSE`](./LICENSE) for more information.
+
+## Contact
+
+If you have a query or require support with this project, [raise an issue](https://github.com/Citi/gradle-helm-plugin/issues). Otherwise, reach out to opensource@citi.com.
diff --git a/helm-plugin/src/test/kotlin/com/citi/gradle/plugins/helm/PluginVersionSynchronization.kt b/helm-plugin/src/test/kotlin/com/citi/gradle/plugins/helm/PluginVersionSynchronization.kt
index 89e2898a..97712b3c 100644
--- a/helm-plugin/src/test/kotlin/com/citi/gradle/plugins/helm/PluginVersionSynchronization.kt
+++ b/helm-plugin/src/test/kotlin/com/citi/gradle/plugins/helm/PluginVersionSynchronization.kt
@@ -13,9 +13,9 @@ class PluginVersionSynchronization {
@Test
fun pluginVersionShouldBeTheSameWithDocumentation() {
val pluginVersion = getPluginVersion()
- val expectedDocumentationLine = ":version: $pluginVersion"
+ val expectedDocumentationLine = "$pluginVersion"
- val readmeFile = File("../README.adoc").absoluteFile.readText()
+ val readmeFile = File("../README.md").absoluteFile.readText()
readmeFile shouldContain expectedDocumentationLine
}
+
+
+ 
