janhoy commented on code in PR #2415: URL: https://github.com/apache/solr/pull/2415#discussion_r1575350183
########## dev-docs/releasing.adoc: ########## @@ -0,0 +1,52 @@ + += Releasing Solr +:toc: left + +== Motiviated? +So you're of the opinion that there are unreleased features or bugfixes commited to the solr repository that the world needs? +Are you so convinced of this that you are willing to volunteer to make it happen? +Good! This document tells you how to get started. + +== Step 0 - Become a committer +To do a release you must become a https://community.apache.org/contributors/becomingacommitter.html[commiter] on the project. Additionally, if you are not on the PMC you will also need to take special steps, and you will need to partner with a PMC member for at least one step. See https://www.apache.org/legal/release-policy.html#upload-ci + +== Step 1 - Run the release wizard! + +But wait, don't I need community approval? (you exclaim) + +Yes! But there are some details to take care of that don't require anyone's approval, and getting comfortable with the release wizard will make it smoother so you should run through the early sections of the release wizard first. + +=== Where to find the release wizard + +The release wizard is found in a checkout of solr at `/solr/devtools/scripts/releaseWizard.py` Review Comment: ```suggestion The release wizard is found in a checkout of solr at `dev-tools/scripts/releaseWizard.py` ``` ########## dev-docs/releasing.adoc: ########## @@ -0,0 +1,52 @@ + += Releasing Solr +:toc: left + +== Motiviated? +So you're of the opinion that there are unreleased features or bugfixes commited to the solr repository that the world needs? +Are you so convinced of this that you are willing to volunteer to make it happen? +Good! This document tells you how to get started. + +== Step 0 - Become a committer +To do a release you must become a https://community.apache.org/contributors/becomingacommitter.html[commiter] on the project. Additionally, if you are not on the PMC you will also need to take special steps, and you will need to partner with a PMC member for at least one step. See https://www.apache.org/legal/release-policy.html#upload-ci + +== Step 1 - Run the release wizard! + +But wait, don't I need community approval? (you exclaim) + +Yes! But there are some details to take care of that don't require anyone's approval, and getting comfortable with the release wizard will make it smoother so you should run through the early sections of the release wizard first. + +=== Where to find the release wizard + +The release wizard is found in a checkout of solr at `/solr/devtools/scripts/releaseWizard.py` + +=== What working copy to use + +The release wizard is meant to be used from any working copy you like, with the expectation that you will check out the PARENT branch. The wizard will (eventually) guide you into creating a fresh, clean checkout, but you don't need that at the start. + +=== How to run the release wizard + +1. Make sure you have python 3.4+ installed (if a higher version becomes required, the wizard should complain and tell you what it is) +2. Run the command you see documented at /solr/dev-tools/scripts/README.md using --dry-run initially is fine. Review Comment: ```suggestion 2. Install dependencies with `pip3 install -r requirements.txt`, from the `dev-tools/scripts` folder. 3. Run the command you see documented at `dev-tools/scripts/README.md` using `--dry-run` initially is fine. ``` -- 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]
