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
hiroyuki-sato committed May 13, 2024
1 parent 0f397b6 commit e35d433
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 output plugin for Embulk
# embulk-output-command

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

## Overview

Expand Down Expand Up @@ -57,8 +57,44 @@ out:
type: csv
```

## Build
For Maintainers
----------------

### Release

Modify `version` in `build.gradle` at a detached commit, and then tag the commit with an annotation.

```
git checkout --detach main

(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 e35d433

Please sign in to comment.