From 75c09fc502d21a699a6fec712c87e589dc712435 Mon Sep 17 00:00:00 2001
From: Dai MIKURUBE <dmikurube@acm.org>
Date: Fri, 10 May 2024 00:32:01 +0900
Subject: [PATCH] Update README with information for maintainers

---
 README.md | 44 ++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 40 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 00e68fd..6fb3296 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# Command file input plugin for Embulk
+# embulk-input-command
 
-This plugin runs a command and reads data from its stdout (or stderr).
+Command file input plugin for Embulk: runs a command and reads data from its stdout (or stderr).
 
 ## Overview
 
@@ -22,8 +22,44 @@ in:
   command: echo "a,c,c" && echo "1,2,3" && echo "10,11,12" | grep -v 10
 ```
 
-## Build
+For Maintainers
+----------------
+
+### Release
+
+Modify `version` in `build.gradle` at a detached commit, and then tag the commit with an annotation.
+
+```
+git checkout --detach master
+
+(Edit: Remove "-SNAPSHOT" in "version" in build.gradle.)
+
+git add build.gradle
+
+git commit -m "Release vX.Y.Z"
+
+git tag -a vX.Y.Z
+
+(Edit: Write a tag annotation in the changelog format.)
+```
+
+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.
+
+```
+## [X.Y.Z] - YYYY-MM-DD
+
+### Added
+- Added a feature.
+
+### Changed
+- Changed something.
+
+### Fixed
+- Fixed a bug.
+```
+
+Push the annotated tag, then. It triggers a release operation on GitHub Actions after approval.
 
 ```
-$ ./gradlew gem
+git push -u origin vX.Y.Z
 ```