Add in Release documentation

Signed-off-by: Maysun J Faisal <maysunaneek@gmail.com>
redhat-appstudio · Sep 11, 2023 · 2593b4b · 2593b4b
1 parent b8432c1
commit 2593b4b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,9 @@ This repository is closely associated with the [application-api](https://github.
 * [Pact tests](./docs/pact-tests.md) - contract testing using a Pact framework is part of the unit tests
 * [OpenShift CI job artifacts](https://docs.ci.openshift.org/docs/how-tos/artifacts/) - Prow job executed by the CI system generates an artifacts directory, this doc describes the contents of this directory and how they can be used to investigate the job steps
 
+## Release
+
+For more information on the application-service release policy, please read the release [guideline](./docs/release.md).
 
 ## Contributions
 

diff --git a/docs/release.md b/docs/release.md
@@ -0,0 +1,5 @@
+# Release
+
+The application-service repository does not do GitHub releases at the moment. Consumers of the application-service Go module are expected to update to the latest commit on a frequent basis. 
+
+Any depreceation or breaking changes are documented as part of the code change in the PR or the function description.