Skip to content

Commit 66b8851

Browse files
authored
Doc: Set version attribute in plugin source file (#308)
Update links to long format to pick up version Bump to v4.4.1 Note that we're resetting the version attribute to `current` at the end of the file to avoid carry over to other files. After we resolve formatting and clean up older files, we can remove the reset in the source file.
1 parent 1891b34 commit 66b8851

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

Diff for: CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
## Unreleased
1+
## 4.4.1
22
- Fix: update to Gradle 7 [#305](https://github.com/logstash-plugins/logstash-input-file/pull/305)
3+
- [DOC] Add version attributes to doc source file [#308](https://github.com/logstash-plugins/logstash-input-file/pull/308)
34

45
## 4.4.0
56
- Add support for ECS v8 [#301](https://github.com/logstash-plugins/logstash-input-file/pull/301)

Diff for: docs/index.asciidoc

+14-4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ START - GENERATED VARIABLES, DO NOT EDIT!
99
:release_date: %RELEASE_DATE%
1010
:changelog_url: %CHANGELOG_URL%
1111
:include_path: ../../../../logstash/docs/include
12+
13+
ifeval::["{versioned_docs}"=="true"]
14+
:branch: %BRANCH%
15+
:ecs_version: %ECS_VERSION%
16+
endif::[]
1217
///////////////////////////////////////////
1318
END - GENERATED VARIABLES, DO NOT EDIT!
1419
///////////////////////////////////////////
@@ -82,7 +87,7 @@ was not ideal and a dedicated Read mode is an improvement.
8287
==== Compatibility with the Elastic Common Schema (ECS)
8388

8489
This plugin adds metadata about event's source, and can be configured to do so
85-
in an {ecs-ref}[ECS-compatible] way with <<plugins-{type}s-{plugin}-ecs_compatibility>>.
90+
in an https://www.elastic.co/guide/en/ecs/{ecs_version}/index.html[ECS-compatible] way with <<plugins-{type}s-{plugin}-ecs_compatibility>>.
8691
This metadata is added after the event has been decoded by the appropriate codec,
8792
and will never overwrite existing values.
8893

@@ -270,7 +275,7 @@ In practice, this will be the best case because the time taken to read new conte
270275
** Otherwise, the default value is `disabled`.
271276

272277
Controls this plugin's compatibility with the
273-
{ecs-ref}[Elastic Common Schema (ECS)].
278+
https://www.elastic.co/guide/en/ecs/{ecs_version}/index.html[Elastic Common Schema (ECS)].
274279

275280
[id="plugins-{type}s-{plugin}-exclude"]
276281
===== `exclude`
@@ -426,7 +431,7 @@ of `/var/log` will be done for all `*.log` files.
426431
Paths must be absolute and cannot be relative.
427432

428433
You may also configure multiple paths. See an example
429-
on the {logstash-ref}/configuration-file-structure.html#array[Logstash configuration page].
434+
on the https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html#array[Logstash configuration page].
430435

431436
[id="plugins-{type}s-{plugin}-sincedb_clean_after"]
432437
===== `sincedb_clean_after`
@@ -439,7 +444,7 @@ The sincedb record now has a last active timestamp associated with it.
439444
If no changes are detected in a tracked file in the last N days its sincedb
440445
tracking record expires and will not be persisted.
441446
This option helps protect against the inode recycling problem.
442-
Filebeat has a {filebeat-ref}/inode-reuse-issue.html[FAQ about inode recycling].
447+
Filebeat has an https://www.elastic.co/guide/en/beats/filebeat/{branch}}/inode-reuse-issue.html[FAQ about inode recycling].
443448

444449
[id="plugins-{type}s-{plugin}-sincedb_path"]
445450
===== `sincedb_path`
@@ -533,4 +538,9 @@ Supported values: `us` `usec` `usecs`, e.g. "600 us", "800 usec", "900 usecs"
533538
[NOTE]
534539
`micro` `micros` and `microseconds` are not supported
535540

541+
ifeval::["{versioned_docs}"=="true"]
542+
:branch: current
543+
:ecs_version: current
544+
endif::[]
545+
536546
:default_codec!:

Diff for: logstash-input-file.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Gem::Specification.new do |s|
22

33
s.name = 'logstash-input-file'
4-
s.version = '4.4.0'
4+
s.version = '4.4.1'
55
s.licenses = ['Apache-2.0']
66
s.summary = "Streams events from files"
77
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

0 commit comments

Comments
 (0)