|
1 | | -embulk-util-rubytime |
2 | | -===================== |
| 1 | +Embulk Utilities for Ruby Time |
| 2 | +=============================== |
3 | 3 |
|
4 | | -How to release |
5 | | ---------------- |
| 4 | +Almost Ruby-compatible date-time processor for Embulk and Embulk plugins. |
6 | 5 |
|
7 | | -See also: https://central.sonatype.org/pages/gradle.html |
| 6 | +For Embulk plugin developers |
| 7 | +----------------------------- |
8 | 8 |
|
9 | | -### Sonatype |
| 9 | +* [Javadoc](https://dev.embulk.org/embulk-util-config/) |
10 | 10 |
|
11 | | -1. Create your account on Sonatype OSSRH. |
12 | | -2. Set your account information in your `gradle.properties` (usually in `~/.gradle/gradle.properties`). |
13 | | - * ``` |
14 | | - ossrhUsername=<your Sonatype OSSRH username> |
15 | | - ossrhPassword=<your Sonatype OSSRH password> |
16 | | - ``` |
| 11 | +For Maintainers |
| 12 | +---------------- |
17 | 13 |
|
18 | | -### OpenPGP |
| 14 | +### Release |
19 | 15 |
|
20 | | -1. Create your own OpenPGP key pair. |
21 | | -2. Set your OpenPGP key information in your `gradle.properties`. |
22 | | - * ``` |
23 | | - # For example: signing.keyId=1234ABCD |
24 | | - signing.keyId=<your OpenPGP key ID> |
25 | | - signing.password=<your OpenPGP key password> |
26 | | - # For example: signing.secretKeyRingFile=/home/you/.gnupg/1234567890ABCDEF1234567890ABCDEF12345678.secring.gpg |
27 | | - signing.secretKeyRingFile=<path to your OpenPGP secret key ring file> |
28 | | - ``` |
| 16 | +Modify `version` in `build.gradle` at a detached commit, and then tag the commit with an annotation. |
29 | 17 |
|
30 | | -### Release |
| 18 | +``` |
| 19 | +git checkout --detach master |
| 20 | +
|
| 21 | +(Edit: Remove "-SNAPSHOT" in "version" in build.gradle.) |
| 22 | +
|
| 23 | +git add build.gradle |
| 24 | +
|
| 25 | +git commit -m "Release vX.Y.Z" |
| 26 | +
|
| 27 | +git tag -a vX.Y.Z |
| 28 | +
|
| 29 | +(Edit: Write a tag annotation in the changelog format.) |
| 30 | +``` |
| 31 | + |
| 32 | +See [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) for the changelog format. We adopt a part of it for Git's tag annotation like below. |
| 33 | + |
| 34 | +``` |
| 35 | +## [X.Y.Z] - YYYY-MM-DD |
| 36 | +
|
| 37 | +### Added |
| 38 | +- Added a feature. |
| 39 | +
|
| 40 | +### Changed |
| 41 | +- Changed something. |
| 42 | +
|
| 43 | +### Fixed |
| 44 | +- Fixed a bug. |
| 45 | +``` |
| 46 | + |
| 47 | +Push the annotated tag, then. It triggers a release operation on GitHub Actions after approval. |
31 | 48 |
|
32 | | -1. Create a detached `HEAD` from the `master` branch. |
33 | | - * ``` |
34 | | - git checkout master |
35 | | - git checkout --detach |
36 | | - ``` |
37 | | -2. Remove `-SNAPSHOT` from the version number in `build.gradle`. |
38 | | -3. Commit it and tag. |
39 | | - * ``` |
40 | | - git add build.gradle |
41 | | - git commit -m "Release vX.Y.Z" |
42 | | - git tag vX.Y.Z |
43 | | - ``` |
44 | | -4. Release. |
45 | | - * ``` |
46 | | - ./gradlew -Dorg.gradle.internal.publish.checksums.insecure=true publishMavenPublicationToMavenCentralRepository |
47 | | - ``` |
48 | | - * `-Dorg.gradle.internal.publish.checksums.insecure=true` is required due to: https://issues.sonatype.org/browse/OSSRH-56097 |
49 | | -5. Push the tag. |
50 | | - * ``` |
51 | | - git push -u origin vX.Y.Z |
52 | | - ``` |
53 | | -6. Back to `master`. |
54 | | - * ``` |
55 | | - git checkout master |
56 | | - ``` |
57 | | -7. Continue to the next `-SNAPSHOT` version. |
| 49 | +``` |
| 50 | +git push -u origin vX.Y.Z |
| 51 | +``` |
0 commit comments