Skip to content

Commit

Permalink
Update README with information for maintainers
Browse files Browse the repository at this point in the history
  • Loading branch information
dmikurube committed May 9, 2024
1 parent 1f0cdd7 commit 75c09fc
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
```

0 comments on commit 75c09fc

Please sign in to comment.