Skip to content

Commit e35d433

Browse files
committed
Update README with information for maintainers
1 parent 0f397b6 commit e35d433

File tree

1 file changed

+40
-4
lines changed

1 file changed

+40
-4
lines changed

README.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Command file output plugin for Embulk
1+
# embulk-output-command
22

3-
This plugin runs a command and writes formatted data to its stdin.
3+
Command file output plugin for Embulk: runs a command and writes formatted data to its stdin.
44

55
## Overview
66

@@ -57,8 +57,44 @@ out:
5757
type: csv
5858
```
5959

60-
## Build
60+
For Maintainers
61+
----------------
62+
63+
### Release
64+
65+
Modify `version` in `build.gradle` at a detached commit, and then tag the commit with an annotation.
66+
67+
```
68+
git checkout --detach main
69+
70+
(Edit: Remove "-SNAPSHOT" in "version" in build.gradle.)
71+
72+
git add build.gradle
73+
74+
git commit -m "Release vX.Y.Z"
75+
76+
git tag -a vX.Y.Z
77+
78+
(Edit: Write a tag annotation in the changelog format.)
79+
```
80+
81+
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.
82+
83+
```
84+
## [X.Y.Z] - YYYY-MM-DD
85+
86+
### Added
87+
- Added a feature.
88+
89+
### Changed
90+
- Changed something.
91+
92+
### Fixed
93+
- Fixed a bug.
94+
```
95+
96+
Push the annotated tag, then. It triggers a release operation on GitHub Actions after approval.
6197
6298
```
63-
$ ./gradlew gem
99+
git push -u origin vX.Y.Z
64100
```

0 commit comments

Comments
 (0)