Polish

Author: marcingrzejszczak

README.adoc

@@ -402,3 +402,71 @@ Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on t
 - `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`.
 
 IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.
+
+== Releasing
+
+=== Bump the versions of all the dependencies
+
+Go to root project's `pom.xml` and update the properties to point to proper dependency versions.
+
+===  Update the project versions
+
+```bash
+$ otelVersion="1.0.0-M8" && ./mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && pushd spring-cloud-sleuth-otel-dependencies && ../mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && popd
+```
+
+IMPORTANT: Notice that we have to update the `otel-dependencies` module manually.
+
+=== Build the project
+
+IMPORTANT: Remember to add a proper profile. `milestone` for milestones / release candidates, `central` for GA versions. No profile is required for snapshots.
+
+```bash
+$ ./mvnw clean install -Pmilestone
+```
+
+or
+
+```bash
+$ ./mvnw clean install -Pcentral
+```
+
+=== Upload the artifacts
+
+```bash
+$ ./mvnw deploy -Pmilestone
+```
+
+or
+
+```bash
+$ ./mvnw deploy -Pcentral
+```
+
+=== Commit and tag
+
+```bash
+$ ./mvnw versions:commit
+$ otelVersion="1.0.0-M8" && ./mvnw versions:set-scm-tag -DnewTag="${otelVersion}"
+```
+
+=== Generate and update the docs
+
+```bash
+$ ./mvnw clean install -Pdocs -pl docs
+$ export otelVersion="1.0.0-M8"
+$ temporaryDir="/tmp/sleuth-otel"  && rm -rf "${temporaryDir}" && mkdir -p "${temporaryDir}" && cp -r docs/target/generated-docs/* "${temporaryDir}" && git checkout gh-pages && git reset --hard origin/gh-pages && rm -rf "docs/${otelVersion}" && mkdir -p "docs/${otelVersion}" && cp -rf "${temporaryDir}"/* "docs/${otelVersion}/" && pushd docs && rm current && ln -s "${otelVersion}" current && git add . && git commit -m "Updated site" && git push origin gh-pages
+```
+
+=== Go back to snapshots
+
+```bash
+$ otelVersion="1.0.0-SNAPSHOT" && ./mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && pushd spring-cloud-sleuth-otel-dependencies && ../mvnw versions:set -DnewVersion="${otelVersion}" -DgenerateBackupPoms=false && popd
+```
+
+=== Commit and push tags
+
+```bash
+$ ./mvnw versions:commit
+$ git push origin --tags
+```

docs/src/main/asciidoc/__releasing.adoc

@@ -48,7 +48,7 @@ $ otelVersion="1.0.0-M8" && ./mvnw versions:set-scm-tag -DnewTag="${otelVersion}
 ```bash
 $ ./mvnw clean install -Pdocs -pl docs
 $ export otelVersion="1.0.0-M8"
-$ temporaryDir="/tmp/sleuth-otel"  && rm -rf "${temporaryDir}" && mkdir -p "${temporaryDir}" && cp -r docs/target/generated-docs/* "${temporaryDir}" && git checkout gh-pages && git reset --hard origin/gh-pages && rm -rf "${temporaryDir}/docs/${otelVersion}" && mkdir "${temporaryDir}/docs/${otelVersion}" && cp -rf "${temporaryDir}"/* "${temporaryDir}/docs/${otelVersion}" && git add . && git commit -m "Updated site" && git push origin gh-pages
+$ temporaryDir="/tmp/sleuth-otel"  && rm -rf "${temporaryDir}" && mkdir -p "${temporaryDir}" && cp -r docs/target/generated-docs/* "${temporaryDir}" && git checkout gh-pages && git reset --hard origin/gh-pages && rm -rf "docs/${otelVersion}" && mkdir -p "docs/${otelVersion}" && cp -rf "${temporaryDir}"/* "docs/${otelVersion}/" && pushd docs && rm current && ln -s "${otelVersion}" current && git add . && git commit -m "Updated site" && git push origin gh-pages
 ```
 
 === Go back to snapshots