Skip to content

chore: add securitiy policy#595

Merged
JoanFM merged 2 commits intomainfrom
chore-security-policy
Oct 7, 2022
Merged

chore: add securitiy policy#595
JoanFM merged 2 commits intomainfrom
chore-security-policy

Conversation

@samsja
Copy link
Copy Markdown
Member

@samsja samsja commented Oct 7, 2022

Signed-off-by: samsja [email protected]

Context

OpenSSF badge require a security policy. We have it on jina but not on docarray (https://github.com/jina-ai/jina/blob/master/SECURITY.md)

What this PR do:

Add a (smally) modified security policy from the jina one

@samsja samsja enabled auto-merge (squash) October 7, 2022 09:36
@github-actions github-actions bot added the size/s label Oct 7, 2022
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 7, 2022

Codecov Report

Merging #595 (2d1b32c) into main (376e9fa) will decrease coverage by 0.00%.
The diff coverage is 42.10%.

❗ Current head 2d1b32c differs from pull request most recent head 3060ff6. Consider uploading reports for the commit 3060ff6 to get more accurate results

@@            Coverage Diff             @@
##             main     #595      +/-   ##
==========================================
- Coverage   84.92%   84.92%   -0.01%     
==========================================
  Files         133      133              
  Lines        6708     6714       +6     
==========================================
+ Hits         5697     5702       +5     
- Misses       1011     1012       +1     
Flag Coverage Δ
docarray 84.92% <42.10%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
docarray/array/mixins/find.py 88.65% <0.00%> (ø)
docarray/array/queryset/lookup.py 78.26% <0.00%> (ø)
docarray/array/queryset/parser.py 87.09% <0.00%> (ø)
docarray/array/storage/annlite/helper.py 50.00% <0.00%> (ø)
docarray/document/generators.py 86.32% <0.00%> (ø)
docarray/document/mixins/plot.py 78.91% <0.00%> (ø)
docarray/document/mixins/porting.py 93.15% <0.00%> (ø)
docarray/dataclasses/setter.py 92.15% <33.33%> (-3.68%) ⬇️
docarray/dataclasses/types.py 91.37% <50.00%> (ø)
docarray/document/mixins/multimodal.py 93.33% <50.00%> (ø)
... and 5 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@JoanFM JoanFM requested a review from NicholasDunham October 7, 2022 10:04
@samsja samsja mentioned this pull request Oct 7, 2022
4 tasks

## Supported Versions

The latest versions of DocArray are supported.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this specific enough? Do we mean the latest version, the latest two versions, or the latest five versions? Minor versions or patch versions?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I copy past from jina core tbh.

I think that it means that the last minor version is supported as our plan now is not maintain older minor version (ex 3.0) since we merge bug fix in the newer version

Co-authored-by: Nicholas Dunham <[email protected]>
Signed-off-by: samsja <[email protected]>
Copy link
Copy Markdown
Contributor

@NicholasDunham NicholasDunham left a comment

Choose a reason for hiding this comment

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

LGTM

@samsja samsja disabled auto-merge October 7, 2022 15:10
@JoanFM JoanFM merged commit 734a210 into main Oct 7, 2022
@JoanFM JoanFM deleted the chore-security-policy branch October 7, 2022 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants