Kusuma04-dev commented on code in PR #62: URL: https://github.com/apache/incubator-kie-website/pull/62#discussion_r4388391248
########## docs/community/devs/release-procedure.md: ########## @@ -0,0 +1,577 @@ +--- +id: release-procedure +title: Release Procedure +sidebar_position: 1 +--- + +This document describes how to perform an Apache KIE release. It covers the repositories involved, how branches and tags are named, and every step from creating a release candidate to publishing the final release. + +:::note +Starting with **10.3**, all Java components (Drools, OptaPlanner, Kogito Runtimes, and Kogito Apps) were merged into a single repository called `incubator-kie`. This means the release process is now a **two-repo** workflow (one command or Jenkins job per repository) instead of the multi-repo process used in 10.2. +::: + +--- + +## Overview + +A KIE release involves two repositories: + +| Repository | What it contains | Language / tooling | +|---|---|---| +| [`incubator-kie`](https://github.com/apache/incubator-kie) | Drools, OptaPlanner, jBPM, Kogito | Java / Maven | +| [`incubator-kie-tools`](https://github.com/apache/incubator-kie-tools) | VS Code extensions, Chrome extensions, web apps like KIE Sandbox, container images, Helm charts | Node.js / Go / pnpm | + +All release scripts live inside each repository: +- **`incubator-kie`**: [`script/release/`](https://github.com/apache/incubator-kie/tree/main/script/release/) — each script supports `--dry-run`. See the [`README.md`](https://github.com/apache/incubator-kie/blob/main/script/release/README.md) there for the per-script reference. +- **`incubator-kie-tools`**: [`scripts/release/`](https://github.com/apache/incubator-kie-tools/tree/main/scripts/release/) — see the [`README.md`](https://github.com/apache/incubator-kie-tools/blob/main/scripts/release/README.md) there for details. + +This page is the **single source of truth** for the release procedure. The `RELEASING.md` files in both repositories only point here. + +### Who can run a release + +A release is run by an Apache KIE **Release Manager (RM)**, a PPMC member or a committer designated by the PPMC. Running the Jenkins jobs requires: + +- Permission to trigger jobs in the Apache KIE Jenkins instance. +- Write access to `apache/incubator-kie` and `apache/incubator-kie-tools` (to push stream branches and tags). +- Your GPG key in the [Apache KIE KEYS file](https://downloads.apache.org/incubator/kie/KEYS) when you sign locally. +- An ASF account with access to `repository.apache.org` (Nexus) and `dist.apache.org` (SVN) to close/release the staging repository and move artifacts. + +### Credentials used by the Jenkins jobs + +These are configured in Jenkins, not typed in by the RM. Running locally needs the equivalent values in your environment. + +| Credential | Used by | Local equivalent | +|---|---|---| +| Maven `settings.xml` with the `apache.releases.https` server (Config File Provider, default id `kie-release-authn-settings`) | `incubator-kie` release job | `MAVEN_SETTINGS=/path/to/settings.xml` | +| GPG signing key (secret file, default id `GPG_KEY_FILE`) and optional passphrase | `incubator-kie` release job; `incubator-kie-tools` release-candidate job | Your local GPG agent, or `MAVEN_GPG_PASSPHRASE` | +| GitHub push credential (username/password) | Pushing stream branches and tags in both repositories | SSH key or token with push access | +| ASF SVN staging credential (id `kie-svn-credentials`) | `incubator-kie-tools` release-candidate job (upload to `dist/dev`) | `svn` with your ASF account | +| npm token, VS Code Marketplace PAT, Chrome Web Store tokens, Docker Hub and Helm registry credentials, GitHub token | `incubator-kie-tools` release-publish job | `NPM_TOKEN`, `VSCE_PAT`, `CHROME_*`, `DOCKER_*`, `HELM_*`, `GITHUB_TOKEN` | + +### Where the output goes + +| Output | Location | +|---|---| +| Java artifacts (JARs, POMs, sources, Javadocs) | Nexus staging repository `orgapachekie-XXXX` at [repository.apache.org](https://repository.apache.org) | +| Tools RC artifacts, signatures and checksums | `https://dist.apache.org/repos/dist/dev/incubator/kie/<rc-version>/` | +| Release tags | `X.Y.Z-rcN` and `X.Y.Z` in each repository | +| Tools public artifacts | npm, VS Code Marketplace, Chrome Web Store, Docker Hub, GitHub Release | + +### Jenkins jobs + +| Repository | Jenkinsfile | Purpose | +|---|---|---| +| `incubator-kie` | `.ci/jenkins/Jenkinsfile.103xplus.release` | Stream branch cut (optional), RC tag, build, deploy to Nexus staging | Review Comment: It was .release only Tiago, but now to make consistent with tools , i have renamed it and updated! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
