Skip to content

Commit 002cbf1

Browse files
ravi-kumar-pillaravi-kumar-pilla
authored
Merge pull request #9 from kedro-org/chore/compliance
Add compliance docs
2 parents da8d30d + 75b07ad commit 002cbf1

File tree

10 files changed

+522
-46
lines changed

10 files changed

+522
-46
lines changed

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
* @rashidakanchwala @ravi-kumar-pilla
22

33
*.py @rashidakanchwala @ravi-kumar-pilla
4-
*.md @rashidakanchwala @ravi-kumar-pilla @NeroOkwa
4+
*.md @rashidakanchwala @ravi-kumar-pilla
55

66
.gitignore @ravi-kumar-pilla
7-
CODEOWNERS @rashidakanchwala @ravi-kumar-pilla @NeroOkwa
7+
CODEOWNERS @rashidakanchwala @ravi-kumar-pilla

‎.github/workflows/detect-secrets.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Detect secrets on Publish Kedro-Viz
2+
3+
on:
4+
push:
5+
branches:
6+
- "*"
7+
pull_request:
8+
branches:
9+
- main
10+
workflow_dispatch:
11+
12+
jobs:
13+
detect-secrets:
14+
permissions:
15+
contents: read
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v5
20+
- name: Set up Python 3.11
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: "3.11"
24+
- name: Install detect-secrets
25+
run: pip install detect-secrets
26+
- name: Scan all tracked files
27+
run: |
28+
detect-secrets scan --all-files --force-use-all-plugins

‎.github/workflows/test.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
name: Test publish-kedro-viz
44

55
permissions:
6-
contents: write
6+
contents: read
77
pages: write
88
id-token: write
99

@@ -63,4 +63,4 @@ jobs:
6363
uses: ./
6464
with:
6565
project_path: "demo-project"
66-
python_manager: "uv"
66+
python_manager: "uv"

‎CODE_OF_CONDUCT.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behaviour that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behaviour by participants include:
24+
25+
* The use of sexualised language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behaviour and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behaviour.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviours that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
58+
reported by contacting the project team on [Slack](https://slack.kedro.org). All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
**Investigation Timeline:** The project team will make all reasonable efforts to initiate and conclude the investigation in a timely fashion. Depending on the type of investigation the steps and timeline for each investigation will vary.
69+
70+
## Attribution
71+
72+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
73+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
74+
75+
[homepage]: https://www.contributor-covenant.org
76+
77+
For answers to common questions about this code of conduct, see
78+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing
2+
3+
## Submitting a pull request
4+
5+
1. Fork and clone the repository
6+
2. Create a new branch: `git checkout -b my-branch-name`
7+
3. Make your change and make sure the test workflow in `test.yml` still passes
8+
4. Push to your fork and submit a pull request
9+
10+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
11+
12+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
13+
14+
## Resources
15+
16+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
17+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
18+
- [GitHub Help](https://help.github.com)
19+
- [Writing good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)

‎PRIVACY.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Privacy Policy
2+
3+
## Privacy Notice
4+
5+
**No personal data is collected or stored by this GitHub Action.** This Action only processes your Kedro project files locally within the GitHub Actions runner environment to generate static visualization artifacts.
6+
7+
## Data Processing Summary
8+
9+
- **Data Processed**: Kedro project configuration files, pipeline definitions, and metadata
10+
- **Processing Location**: GitHub Actions runner (ephemeral environment)
11+
- **Data Storage**: No persistent data storage by this Action
12+
- **Data Transmission**: Only static HTML/JS/CSS artifacts uploaded to GitHub Pages
13+
14+
## Telemetry and Opt-Out
15+
16+
This Action includes an optional telemetry feature input that controls whether the Kedro framework sends usage data to Kedro Org. The Action does not collect any telemetry data directly - it only sets the telemetry consent configuration for your Kedro project by writing the consent value to the `.telemetry` file.
17+
18+
- **Default Setting**: Telemetry is **disabled by default** (`telemetry_consent: false`)
19+
- **Opt-In Required**: You must explicitly set `telemetry_consent: true` to enable
20+
- **Data Sent**: Anonymous usage statistics about Kedro-Viz features used
21+
- **Opt-Out Instructions**: Keep `telemetry_consent: false` (default) or omit the parameter
22+
23+
### How to Disable Telemetry Explicitly
24+
25+
```yaml
26+
- uses: kedro-org/publish-kedro-viz@v3
27+
with:
28+
telemetry_consent: false # Explicitly disable (default)
29+
```
30+
31+
## GDPR/CCPA Compliance
32+
33+
This Action complies with GitHub's Data Protection Addendum and applicable data protection regulations:
34+
35+
- No personal data collection or processing
36+
- No cookies or tracking mechanisms
37+
- No data retention beyond GitHub Actions job execution
38+
- Processing limited to generating static visualizations
39+
40+
## Data Controller Information
41+
42+
**Organization**: Kedro Community (kedro-org)
43+
**Contact**: kedro-framework@mckinsey.com
44+
**Purpose**: Data pipeline visualization and documentation
45+
46+
## Your Rights
47+
48+
Under applicable data protection laws, you have the following rights:
49+
50+
- **Right to Information**: This privacy policy provides information about our data processing
51+
- **Right to Access**: You can request information about any data processing (though we process no personal data)
52+
- **Right to Rectification**: You can request correction of inaccurate data (not applicable as we process no personal data)
53+
- **Right to Erasure**: You can request deletion of personal data (not applicable as we process no personal data)
54+
- **Right to Object**: You can object to data processing by not using this Action or disabling telemetry
55+
56+
## Third-Party Services
57+
58+
This Action uses the following third-party services:
59+
60+
### GitHub Actions Platform
61+
- **Service**: GitHub Actions runner environment
62+
- **Data Shared**: Repository contents during workflow execution
63+
- **Privacy Policy**: [GitHub Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement)
64+
65+
### GitHub Pages
66+
- **Service**: Static website hosting
67+
- **Data Shared**: Generated HTML/JS/CSS artifacts
68+
- **Privacy Policy**: [GitHub Privacy Statement](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement)
69+
70+
### Kedro-Viz Telemetry (Optional)
71+
- **Service**: Anonymous usage analytics (only if explicitly enabled)
72+
- **Data Shared**: Anonymous feature usage statistics
73+
- **Control**: Disabled by default, requires explicit opt-in
74+
75+
### Third-Party GitHub Actions
76+
77+
This Action integrates with the following third-party GitHub Actions:
78+
79+
#### actions/upload-pages-artifact
80+
- **Author**: GitHub (actions organization)
81+
- **Purpose**: Upload build artifacts for GitHub Pages deployment
82+
- **Data Shared**: Generated static website files (HTML/JS/CSS)
83+
- **License**: MIT
84+
- **Repository**: [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact)
85+
86+
#### actions/deploy-pages
87+
- **Author**: GitHub (actions organization)
88+
- **Purpose**: Deploy artifacts to GitHub Pages
89+
- **Data Shared**: Build artifacts for website deployment
90+
- **License**: MIT
91+
- **Repository**: [actions/deploy-pages](https://github.com/actions/deploy-pages)
92+
93+
#### peaceiris/actions-gh-pages (v1 only)
94+
- **Author**: peaceiris
95+
- **Purpose**: Deploy static site to GitHub Pages branch (legacy v1 functionality)
96+
- **Data Shared**: Generated static website files
97+
- **License**: MIT
98+
- **Repository**: [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages)
99+
- **Note**: Used only in v1 of this Action for branch-based deployments
100+
101+
## Changes to This Policy
102+
103+
We may update this privacy policy from time to time. Changes will be reflected in the repository commit history and users will be notified through:
104+
105+
- Updates to this PRIVACY.md file
106+
- Release notes for new versions
107+
- Repository announcements for significant changes
108+
109+
## Contact
110+
111+
For questions about data protection or this privacy policy:
112+
113+
- **Email**: kedro-framework@mckinsey.com
114+
- **Security Issues**: See [SECURITY.md](SECURITY.md)
115+
- **General Support**: See [SUPPORT.md](SUPPORT.md)
116+
117+
---
118+
119+
**Last Updated**: November 19, 2024
120+
**Version**: 1.0

0 commit comments

Comments
 (0)