Creating Robot Framework releases
These instructions cover steps needed to create new Robot Framework releases. Many individual steps are automated, but we do not want to automate the whole procedure because it would be hard to react if something goes terribly wrong. When applicable, the steps are listed as commands that can be copied and executed on the command line.
Some tasks are automated using Invoke. Generating releases requires it to be installed:
pip install invoke
Invoke is executed from the command line like:
inv[oke] task [options]
invoke without arguments for help. All tasks can be listed using
invoke --list and they are defined in tasks.py file.
Generate API docs (including JavaDocs) and see is there is something that should be committed:
doc/api/generate.py git diff doc/api git commit doc/api -m "Regenerated API docs" # if needed
Check that you have nothing left to commit, pull, or push:
git status git pull --rebase git push
Set version information to a shell variable to ease copy-pasting further commands. Add
rcNpostfix if creating a pre-release:
Generate a template for the release notes. Either first create shell variables with GitHub login info or just replace them in the command to actually generate the notes:
GITHUB_USERNAME=<username> GITHUB_PASSWORD=<password> doc/releasenotes/generate.py $VERSION $GITHUB_USERNAME $GITHUB_PASSWORD >> doc/releasenotes/rf-$VERSION.rst
Fill the missing details in the template.
Add, commit and push:
git add doc/releasenotes/rf-$VERSION.rst git commit -m "Release notes for $VERSION" doc/releasenotes/rf-$VERSION.rst git push
Add short release notes to GitHub's releases page with a link to the full release notes.
invoke tag_release $VERSION
Version back to
invoke set_version --push dev
If you are going to create distributions on the same repository, you may want to post-pone this step until they are done.
Checkout earlier created tag if necessary:
git checkout $VERSION
Create and deploy:
invoke sdist --deploy
Verify that https://pypi.python.org/pypi/robotframework looks good.
Test installation (add
pip install robotframework --upgrade
Test that JAR is not totally borken:
java -jar dist/robotframework-$VERSION.jar --version java -jar dist/robotframework-$VERSION.jar atest/testdata/misc/pass_and_fail.robot
Upload JAR to Sonatype
Sonatype offers a service where users can upload JARs and they will be synced to the maven central repository. Below are the instructions to upload the JAR.
Create a Sonatype account
Add these lines (filled with the Sonatype account information) to your
<servers> <server> <id>sonatype-nexus-staging</id> <username></username> <password></password> </server> </servers>
Create a PGP key
Apply for publish rights to org.robotframework project. This will take some time from them to accept.
mvn gpg:sign-and-deploy-file -Dfile=dist/robotframework-$VERSION.jar -DpomFile=pom.xml -Durl=http://oss.sonatype.org/service/local/staging/deploy/maven2/ -DrepositoryId=sonatype-nexus-staging
Go to https://oss.sonatype.org/index.html#welcome, log in with Sonatype credentials, find the staging repository and do close & release
After that, the released JAR is synced to Maven central within an hour.
Create package (updates also library docs):
Update docs at http://robotframework.org/robotframework/:
git checkout gh-pages invoke add_docs $VERSION --push git checkout master
- Twitter: http://twitter.com/robotframework
- Users and announcements mailing lists
- Robot Framework LinkedIn group: https://www.linkedin.com/groups/Robot-Framework-3710899
- With major releases can also consider: