Skip to content

Add NOTICE.txt file at the root level of a package #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rw-access merged 4 commits into from
Mar 17, 2021
Merged

Add NOTICE.txt file at the root level of a package #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3fc9c98
Add NOTICE.txt file at the root level of a package
rw-access Mar 17, 2021
9af8218
Add link to changelog
rw-access Mar 17, 2021
85f5f2d
Update the spec again
rw-access Mar 17, 2021
93a6e57
Merge remote-tracking branch 'origin/master' into add-notice-file
rw-access Mar 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion code/go/internal/spec/statik.go
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions code/go/internal/validator/folder_item_content.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ func loadItemContent(itemPath, mediaType string) ([]byte, error) {
}
case "application/json": // no need to convert the item content
case "text/markdown": // text/markdown can't be transformed into JSON format
case "text/plain": // text/plain should be left as-is
default:
return nil, fmt.Errorf("unsupported media type (%s)", mediaType)
}
Expand Down
2 changes: 2 additions & 0 deletions test/packages/good/NOTICE.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Elastic package-spec
Copyright 2021 Elasticsearch B.V.
3 changes: 3 additions & 0 deletions versions/1/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,6 @@
- description: Remove deprecated JSON-formatted pipeline test configs
type: breaking-change
link: https://github.com/elastic/package-spec/pull/150
- description: Add optional NOTICE.txt file to a package
type: enhancement
link: https://github.com/elastic/package-spec/pull/151
5 changes: 5 additions & 0 deletions versions/1/spec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ spec:
name: "changelog.yml"
required: true
$ref: "./changelog.spec.yml"
- description: The package's NOTICE file
type: file
contentMediaType: "text/plain"
Copy link
Copy Markdown
Contributor

@mtojek mtojek Mar 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to define the content type here provided that no action is taken based on this? Did you try without this definition?

Copy link
Copy Markdown
Contributor Author

@rw-access rw-access Mar 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just made an assumption that this was necessary. I'm not intimately familiar with the details but am glad to remove if that is preferred.

Copy link
Copy Markdown
Contributor

@ycombinator ycombinator Mar 17, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm okay leaving this in. We may not take any action on this content type today but if we do in the future, the NOTICE file would automatically get covered.

name: "NOTICE.txt"
required: false
- description: Folder containing data stream definitions
type: folder
name: data_stream
Expand Down