Skip to content

Commit 716e160

Browse files
committed
Recommendations for proper versioning of the plugin
Want to make sure we don't have inconsistencies between the published versions and the commits in git. Issue #97 and #101
1 parent 7581966 commit 716e160

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,18 @@ git push -f
8787

8888
For guidance on doing the merge itself, see
8989
https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging
90+
91+
## Publishing and versioning
92+
These instructions are only for plugin maintainers; if you are just working
93+
on issues or pull requests, you can ignore this section.
94+
95+
We'd like to maintain proper versioning history for the plugin. This requires
96+
a little bit of coordination between in-code versions, GitHub tags, and
97+
published versions on plugins.gradle.org. The steps are:
98+
99+
1. As a separate commit, bump the version number in `build.gradle`. Use
100+
https://semver.org to guide which slot in the version number should be bumped.
101+
2. Tag that separate commit as for example `v0.2.3-alpha` and push that
102+
tag to the j2objc-contrib/j2objc-gradle repository.
103+
3. Do a clean build and then publish the new version
104+
to https://plugins.gradle.org (`./gradlew clean build publishPlugins`).

0 commit comments

Comments
 (0)