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.

Sign up for GitHub

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

Add docs for internal releases #1787

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Add docs for internal releases #1787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,13 @@
8. `git push && git push --tags`

This will trigger a GitHub Action workflow which will create a GitHub release and upload the release artifacts to Maven Central.

## Internal Releasing

1. Update `VERSION_NAME` in `gradle.properties` to the internal release (non-SNAPSHOT) version. [2.0.0-internal01] Ensure that the name doesn't collide with an already released version.
2. Update `RELEASE_SIGNING_ENABLED` in `gradle.properties` to `false`.
3. Check that the internal variables are configured correctly:
1. `internalUrl` is set in `~/.gradle/gradle.properties` to the internal repository URL.
2. Check `internalUsername` and `internalPassword` are set in `~/.gradle/gradle.properties` to the internal repository credentials.
4. Run `./gradlew publishMavenPublicationToInternalRepository paparazzi-gradle-plugin:publishAllPublicationsToInternalRepository --no-parallel` to publish the internal release.
* *Note* if gradle publish fails with `403` error, ensure the `VERSION_NAME` in step 1 is unique and isn't already published.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be in the open source repository vs internal documentation?

Also, bullet point 3 is referenced here: https://github.com/cashapp/paparazzi/blob/master/build.gradle#L77,L84

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I felt like its "internal" to anyone using the repo and deploying their own internal version. It doesn't have to be explicitly used by Cash.

Loading