GitHub

Woven detects data model changes in Pull Requests and automatically requires that Software engineers update the data model's metadata. Woven makes suggestions that the developer can review, revise and approve to enforce data policies.

To accomplish this, Woven needs to be integrated in all the GitHub repo(s) where data schemas (e.g. ORMs, Proto/Avro, dbt, etc.) are defined.

GitHub apps need to be installed or approved by your company's GitHub admin. If you do not have the necessary permissions, you can still request an install and wait for your admin to approve.

Woven requires GitHub Actions enabled in all repositories. This enables Woven to detect schema changes within your GitHub environment and only send metadata to Woven's servers

1. Install the GitHub app

• Use this link to initiate the installation. You will be asked to login to Woven.

• Choose "All repositories", or just the ones where data schemas are defined.

• Complete installation or send to admin for approval.

2. Merge the configuration PR

Once the app is fully installed, Woven will create one Pull Request in each repository with a few files to setup the repository. Since Woven runs on GitHub actions, configuration files need to be added to each repository.

More Instructions & Examples WIP.

3. Onboarding data models incrementally

Woven's onboarding experience enables the organization to incrementally onboard data models, one team at a time.

More Instructions WIP.

4. Activate all data models

Once a good fraction of data models are onboarded, you can activate Woven to all data models. This makes sure that every data model is protected by enforcing your data policies as part of CI/CD - the Pull Request will be blocked when policies aren't met.

More Instructions WIP