Merge pull request #69 from embulk/README-20250217

Update README.md

Author: dmikurube

README.md

@@ -1,20 +1,22 @@
-# Google Cloud Storage file input plugin for Embulk
-[![Build Status](https://travis-ci.org/embulk/embulk-input-gcs.svg?branch=master)](https://travis-ci.org/embulk/embulk-input-gcs)
+Google Cloud Storage file input plugin for Embulk
+===================================================
 
-## Overview
+Overview
+---------
 
-embulk-input-gcs v0.3.0+ requires Embulk v0.9.12+
+embulk-input-gcs v0.5.0+ requires Embulk v0.11.0+.
 
 * Plugin type: **file input**
 * Resume supported: **yes**
 * Cleanup supported: **yes**
 
-## Usage
+Usage
+------
 
 ### Install plugin
 
 ```
-embulk gem install embulk-input-gcs
+java -jar embulk-X.Y.Z.jar install "org.embulk:embulk-input-gcs:0.5.0"
 ```
 
 ### Google Service Account Settings
@@ -34,7 +36,7 @@ If you chose "private_key" or "json_key" as [auth_method](#Authentication), you
 ### run
 
 ```
-embulk run /path/to/config.yml
+java -jar embulk-X.Y.Z.jar run /path/to/config.yml
 ```
 
 ## Configuration
@@ -50,11 +52,16 @@ embulk run /path/to/config.yml
 - **json_keyfile** fullpath of json_key (string, required when auth_method is json_key)
 - **application_name** application name anything you like (string, optional)
 
-## Example
+Example
+--------
 
 ```yaml
 in:
-  type: gcs
+  type:
+    source: maven
+    group: org.embulk
+    name: gcs
+    verison: "0.5.0"
   bucket: my-gcs-bucket
   path_prefix: logs/csv-
   auth_method: private_key #default
@@ -67,7 +74,11 @@ Example for "sample_01.csv.gz" , generated by [embulk example](https://github.co
 
 ```yaml
 in:
-  type: gcs
+  type:
+    source: maven
+    group: org.embulk
+    name: gcs
+    verison: "0.5.0"
   bucket: my-gcs-bucket
   path_prefix: sample_
   auth_method: private_key #default
@@ -96,7 +107,11 @@ To skip files using regexp:
 
 ```yaml
 in:
-  type: gcs
+  type:
+    source: maven
+    group: org.embulk
+    name: gcs
+    verison: "0.5.0"
   bucket: my-gcs-bucket
   path_prefix: logs/csv-
   # ...
@@ -107,7 +122,8 @@ in:
   #path_match_pattern: .csv$|.csv.gz$    # match files whose suffix is .csv or .csv.gz
 ```
 
-## Authentication
+Authentication
+---------------
 
 There are three methods supported to fetch access token for the service account.
 
@@ -121,7 +137,11 @@ You first need to create a service account (client ID), download its private key
 
 ```yaml
 in:
-  type: gcs
+  type:
+    source: maven
+    group: org.embulk
+    name: gcs
+    verison: "0.5.0"
   auth_method: private_key
   service_account_email: ABCXYZ123ABCXYZ123.gserviceaccount.com
   p12_keyfile: /path/to/p12_keyfile.p12
@@ -133,7 +153,11 @@ You first need to create a service account (client ID), download its json key an
 
 ```yaml
 in:
-  type: gcs
+  type:
+    source: maven
+    group: org.embulk
+    name: gcs
+    verison: "0.5.0"
   auth_method: json_key
   json_keyfile: /path/to/json_keyfile.json
 ```
@@ -142,7 +166,11 @@ You can also embed contents of json_keyfile at config.yml.
 
 ```yaml
 in:
-  type: gcs
+  type:
+    source: maven
+    group: org.embulk
+    name: gcs
+    verison: "0.5.0"
   auth_method: json_key
   json_keyfile:
     content: |
@@ -164,24 +192,32 @@ Compute Engine VM instance, then you can configure embulk like this.
 
 ```yaml
 in:
-  type: gcs
+  type:
+    source: maven
+    group: org.embulk
+    name: gcs
+    verison: "0.5.0"
   auth_method: compute_engine
 ```
 
-## Eventually Consistency
+Eventually Consistency
+-----------------------
 
 An operation listing objects is eventually consistent although getting objects is strongly consistent, see https://cloud.google.com/storage/docs/consistency.
 
 `path_prefix` uses the objects list API, therefore it would miss some of objects.
 If you want to avoid such situations, you should use `paths` option which directly specifies object paths without the objects list API.
 
-## Build
+For Maintainers
+----------------
+
+### Build
 
 ```
-./gradlew gem
+./gradlew jar
 ```
 
-## Test
+### Test
 
 To run unit tests, we need to configure the following environment variables.
 
@@ -230,3 +266,42 @@ $ launchctl getenv GCP_EMAIL //try to get value.
 
 Then start your applications.
 ```
+
+### 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.
+
+```
+git push -u origin vX.Y.Z
+```