This is an automated email from the ASF dual-hosted git repository.
zkaoudi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/wayang-website.git
The following commit(s) were added to refs/heads/main by this push:
new 1a84e71a Update release process documentation (#116)
1a84e71a is described below
commit 1a84e71a0b8e778941bd7a23edb2f8671547a0b9
Author: Zoi Kaoudi <[email protected]>
AuthorDate: Sat May 23 10:23:07 2026 +0200
Update release process documentation (#116)
* Update release process documentation
Clarified the repository versioning note and improved instructions for
release preparation.
* Update how-to-make-a-release.md
---
docs/community/how-to-make-a-release.md | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/docs/community/how-to-make-a-release.md
b/docs/community/how-to-make-a-release.md
index c9549191..a0d2ff9a 100644
--- a/docs/community/how-to-make-a-release.md
+++ b/docs/community/how-to-make-a-release.md
@@ -8,12 +8,12 @@ This guide documents the steps to be followed when making a
release.
**Disclaimer**: Steps were taken mostly from
[here](https://plc4x.apache.org/plc4x/latest/developers/release/release.html)
and thus sentences may have been copied.
-**Convention**: The repository should be in a snapshot version of the next
release. For instance, 1.1.1-SNAPSHOT means that the next release number should
be 1.1.1.
+**NOTE**: The repository **must be in a snapshot version**. Ideally in a
number for the next release. For instance, 1.1.1-SNAPSHOT means that the next
release number should be 1.1.1.
The process in general is as follows. The release manager creates the right
artifacts (source files) using maven commands. This forms a release candidate.
Then the release candidate, which should be uploaded in the "development
directory" of the apache svn server, goes for voting in the dev list. It needs
3 or more positive binding votes (PMC members count as binding votes). Once
accepted, the release can actually happen, where the artifacts are uploaded to
the "release directory" of the [...]
**If any Maven step should fail**:
-Please note that `mvn:release` commands eagerly commit directly to your
working branch, if your command fails you may have to revert the last commit.
+Please note that `mvn release` commands eagerly commit directly to your
working branch, if your command fails you may have to revert the last commit.
1. Clone the repo or pull latest changes:
``git pull``
@@ -23,24 +23,21 @@ Please note that `mvn:release` commands eagerly commit
directly to your working
``git checkout -b release-prep``
- ``mvn release:branch -DbranchName=rel/1.0.0-rc5``
-
3. Switch to branch:
``git checkout rel/1.0.0-rc5``
4. Set upstream of branch:
``git push -u <remote_name> <branch_name>``
-
+If you've previously used git clone on https://github.com/apache/wayang/
remote name should be origin.
+
5. Update RELEASE_NOTES and check NOTICE to have the correct year
6. Check if everything is working:
``mvn clean install``
+7. Run ``mvn release:clean``
-7. Check if there are no SNAPSHOT references: ``find . -type f -name 'pom.xml'
-exec grep -l "SNAPSHOT" {} \;``
-
-8. Run ``mvn release:clean``
-
-9. Modify the tag in the root pom.xml file to contain the right version with
the rc number:
+8. Modify the tag in the root pom.xml file to contain the right version with
the rc number:
`` <tag>v1.0.0-rc5</tag>`` (2 places in the file)
Now depending if it's the first time you do a release continue with the
following steps, otherwise jump to step **16**.
@@ -127,6 +124,14 @@ The following is about key management. Details are
described [here](https://puls
16. Run ``mvn release:prepare`` (you can skip tests with
-Darguments='-DskipTests=True, if you have done this before)
+If prompted:
+``What is the SCM release tag or label for "Apache Wayang"? (wayang)
v1.0.1-SNAPSHOT: : wayang``
+Add wayag-1.0.0
+
+If prompted:
+``What is the new development version for "Apache Wayang"? (wayang)
1.0.1-SNAPSHOT: :``
+Add the new development version *with SNAPSHOT*: eg., 1.0.1-SNAPSHOT
+
17. Run ``mvn clean release:perform`` (This step will ask for your apache
credentials, if everything related to the keys is configured properly.)
18. Go to: https://repository.apache.org, login, go to Staging Repositories
and find the `orgapachewayang-{somenumber}` and close it with description
"Apache Wayang 1.0.0-rc5"
