Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Describe the release procedure #2104

Merged
merged 3 commits into from
Jan 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Appium Java Client Release Procedure

This document describes the process of releasing this client to the Maven repository.
Its target auditory is project maintainers.

## Release Steps

1. Update the [Changelog](../CHANGELOG.md) for the given version based on previous commits.
mykola-mokhnach marked this conversation as resolved.
Show resolved Hide resolved
1. Bump the `appiumClient.version` number in [gradle.properties](../gradle.properties).
1. Create a pull request to approve the changelog and version bump.
1. Merge the pull request after it is approved.
1. Create and push a new repository tag. The tag name should look like
`v<major_number>.<minor_number>.<patch_number>`.
1. Open [Sonatype](https://oss.sonatype.org/#welcome) in your browser.
1. Login to Nexus using 1Password credentials. Ask Appium maintainers
if you need access to the team's 1Password vault.
1. Navigate to `Staging Repositories`.
1. Select the corresponding release and click `Close`.
1. Wait until checks are completed.
1. Click `Release`.
1. After the new release is published, it becomes available in
[Maven Central](https://repo1.maven.org/maven2/io/appium/java-client/)
within 30 minutes. Once artifacts are in Maven Central, it normally
takes 1-2 hours before they appear in
[search results](https://central.sonatype.com/artifact/io.appium/java-client).
Loading