Skip to content

Commit bd7f64a

Browse files
committed
Remove v0.14 to avoid version confusion
Signed-off-by: Masahiro Nakagawa <repeatedly@gmail.com>
1 parent 6f7af81 commit bd7f64a

File tree

6 files changed

+26
-34
lines changed

6 files changed

+26
-34
lines changed

developer/api-plugin-base.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Plugin Base API
22

3-
All plugin types are subclass of `Fluent::Plugin::Base` in Fluentd v0.14
3+
All plugin types are subclass of `Fluent::Plugin::Base` in Fluentd v1
44
or later. Base class has some features and methods which provides basic
55
mechanism as plugins. This page shows these methods provided by
66
`Fluent::Plugin::Base`, and other methods provided commonly in some type

developer/api-plugin-formatter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ should look like `100,200`
6868

6969
Formatter plugins are designed to be used from other plugins, like
7070
Input, Filter and Output. There is a Formatter plugin helper for that
71-
purpose (v0.14.1 or later):
71+
purpose:
7272

7373
```
7474
# in class definition

developer/api-plugin-parser.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ For more details about `<parse>` section, see [Parse section configurations](/co
8686
## How To Use Parsers From Plugins
8787

8888
Parser plugins are designed to be used from other plugins, like Input,
89-
Filter and Output. There is a Parser plugin helper for that purpose
90-
(v0.14.1 or later):
89+
Filter and Output. There is a Parser plugin helper for that purpose:
9190

9291
```
9392
# in class definition

developer/plugin-development.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,19 @@ before they dive into writing their own plugins.
3333
[RubyKaigi 2014 talk](http://rubykaigi.org/2014/presentation/S-NaotoshiSeo/).)
3434

3535
This slide is based on Fluentd v0.12. There are many difference between
36-
v0.12 and v0.14/v1.0 API, but it may help our understanding about
37-
Fluent's total design.
36+
v0.12 and v1 API, but it may help our understanding about Fluent's total design.
3837

3938

4039
### Fluentd version and Plugin API
4140

42-
Fluentd now has two active versions, v1.0 and v0.12. v1.0 is current
43-
stable and v1.0 has brand-new Plugin API. v0.12 is old stable and v0.12
41+
Fluentd now has two active versions, v1 and v0.12. v1 is current
42+
stable and v1 has brand-new Plugin API. v0.12 is old stable and v0.12
4443
has old Plugin API.
4544

46-
The important point is v1.0 supports v1.0 and v0.12 APIs. It means the
47-
plugin for v0.12 works with v1.0.
45+
The important point is v1 supports v1 and v0.12 APIs. It means the
46+
plugin for v0.12 works with v1.
4847

49-
We recommend to use new v1.0 plugin API for new plugins.
48+
We recommend to use new v1 plugin API for new plugins.
5049

5150

5251
### Send a patch or fork?

developer/plugin-update-from-v0.12.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Updating plugin for v1.0 from v0.12
1+
# Updating plugin for v1 from v0.12
22

33
This guide is for plugin authors to show how to update
44
input/output/filter plugins written for Fluentd v0.12 or earlier.
55

66
There are something to be considered (see following "Updating Plugins
77
Overview" section for details):
88

9-
- Plugins which use v0.12 API will be supported between Fluentd v0.14
10-
and v1 (will be obsoleted at v2).
11-
- Users can use new features of Fluentd v1.0 only with plugins using
9+
- Plugins which use v0.12 API will be supported in Fluentd v1
10+
(will be obsoleted at v2).
11+
- Users can use new features of Fluentd v1 only with plugins using
1212
new API.
1313
- Plugins which use new API don't work on Fluentd v0.12.x.
1414

15-
Fluentd core team strongly recommend to use v1.0 API to make your
15+
Fluentd core team strongly recommend to use v1 API to make your
1616
plugins stable, consistent and easy to test.
1717

1818

@@ -24,7 +24,7 @@ These are steps to update your plugins safely.
2424
2. update dependency
2525
3. update code and tests
2626
4. update CI environments
27-
5. release the newer version for Fluentd v0.14.x and later
27+
5. release the newer version for Fluentd v1 and later
2828

2929

3030
### 1. release a latest version
@@ -46,23 +46,19 @@ newer versions for Fluentd v0.12 users without breaking anything.
4646
### 2. update dependency
4747

4848
Following updates are on master branch. You should update dependency in
49-
gemspec at first to depend on Fluentd v0.14.
49+
gemspec at first to depend on Fluentd v1.
5050

51-
- fix dependency about `Fluentd` to `[">= 0.14.0", "< 2"]`
51+
- fix dependency about `Fluentd` to `[">= 1", "< 2"]`
5252
- execute `bundle install`
5353

54-
Is it correct to use `>= 0.14.0` instead of `~> 0.14.0`? Yes. Fluentd v1
55-
will be compatible with v0.14.0 (especially for plugin APIs), so you
56-
should use `>= 0.14.0`. Let's think about v2 few years later.
57-
5854
Recommended dependency in gemspec:
5955

6056
```
6157
# in gemspec
6258
Gem::Specification.new do |gem|
6359
gem.name = "fluent-plugin-my_awesome"
6460
# ...
65-
gem.add_runtime_dependency "fluentd", [">= 0.14.0", "< 2"]
61+
gem.add_runtime_dependency "fluentd", [">= 1", "< 2"]
6662
end
6763
```
6864

@@ -80,12 +76,10 @@ plugins.
8076
### 4. update CI environments
8177

8278
If you have CI configurations like `.travis.yml` and `appvayor.yml`,
83-
these should be updated to support Fluentd v0.14/v1.0. Fluentd
84-
v0.14/v1.0 supports Ruby 2.1 or later. CI environments should not
85-
include Ruby 2.0 or earlier. It's good idea to add latest Ruby (2.4 at
86-
Nov 2017).
79+
these should be updated to support Fluentd v1. Fluentd v1 supports Ruby 2.4 or later.
80+
CI environments should not include Ruby 2.3 or earlier.
8781

88-
- remove Ruby 2.0 or earlier from CI environments
82+
- remove Ruby 2.3 or earlier from CI environments
8983
- add Ruby 2.4 (or other latest version) to CI environments
9084

9185

@@ -98,8 +92,8 @@ Add requirements section to `README.md` like following:
9892
9993
| fluent-plugin-may_awesome | Fluentd | Ruby |
10094
|:--------------------------|:-----------|:-------|
101-
| >= 1.0.0 | >= v0.14.0 | >= 2.1 |
102-
| < 1.0.0 | >= v0.12.0 | >= 1.9 |
95+
| >= 1.0.0 | >= v1 | >= 2.4 |
96+
| < 1.0.0 | >= v0.12.0 | >= 2.1 |
10397
```
10498

10599
This helps that plugin users can understand plugin requirements.
@@ -112,7 +106,7 @@ not patch version up. If the current major version of your gem is equal
112106
or larger than 1, you should bump major version up (e.g., from 1 to 2).
113107
If the current major version is 0, you should bump minor version up
114108
(e.g., from `0.4.2` to `0.5.0`). Then, you can publish a new release
115-
which is available with Fluentd v0.14/v1.0.
109+
which is available with Fluentd v1.
116110

117111
- bump the version up
118112
- release it to rubygems.org

overview/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Use td-agent 3. It includes v1.
1515

1616
## What is the differences between v1 or v0.14?
1717

18-
No differences. v1.0 is built on top of v0.14. Use v1.0 for newer
19-
installation. We use v1.0/v1.x on our document.
18+
No differences. v1 is built on top of v0.14. Use v1 for newer
19+
installation. We use v1 or v1.x on our document.
2020

2121

2222
## Known Issue

0 commit comments

Comments
 (0)