incubator-devlake

README

Apache DevLake(Incubating)

🤔 What is Apache DevLake?

Apache DevLake is an open-source dev data platform that ingests, analyzes, and visualizes the fragmented data from DevOps tools to extract insights for engineering excellence, developer experience, and community growth.

Apache DevLake is designed for developer teams looking to make better sense of their development process and to bring a more data-driven approach to their own practices. You can ask Apache DevLake many questions regarding your development process. Just connect and query.

🎯 What can be accomplished with Apache DevLake?

1. Your Dev Data lives in many silos and tools. DevLake brings them all together to give you a complete view of your Software Development Life Cycle (SDLC).
2. From DORA to scrum retros, DevLake implements metrics effortlessly with prebuilt dashboards supporting common frameworks and goals.
3. DevLake fits teams of all shapes and sizes, and can be readily extended to support new data sources, metrics, and dashboards, with a flexible framework for data collection and transformation.

👉 Live Demo

DORA Dashboard

All Dashboards

💪 Supported Data Sources

Data Source	Domain(s)	Supported Versions	Config UI Availability	Triggered Plugins	Collection Mode
GitHub (include GitHub Action)	Source Code Management, Code Review, Issue Tracking, CI/CD	Cloud	Available	github, gitextractor	Full Refresh, Incremental Sync(for issues, PRs)
GitLab (include GitLabCI)	Source Code Management, Code Review, Issue Tracking, CI/CD	Cloud, Community Edition 13.x+	Available	gitlab, gitextractor	Full Refresh, Incremental Sync(for issues)
Gitee	Source Code Management, Code Review, Issue Tracking	Cloud	Not Available	gitee, gitextractor	Incremental Sync
BitBucket	Source Code Management, Code Review	Cloud	Not Available	bitbucket, gitextractor	Full Refresh
Jira	Issue Tracking	Cloud, Server 8.x+, Data Center 8.x+	Available	jira	Full Refresh, Incremental Sync(for issues, changelogs, worklogs)
TAPD	Issue Tracking	Cloud	Not Available	tapd	Full Refresh, Incremental Sync(for stories, bugs, tasks)
Jenkins	CI/CD	2.263.x+	Available	jenkins	Full Refresh
Feishu	Calendar	Cloud	Not Available	feishu	Full Refresh
AE	Source Code Management		Not Available	ae	Full Refresh
Pagerduty	Issue Tracking	Singer-tap	Not Available	pagerduty	Full Refresh

🚀 Getting Started

• Install via Docker Compose
• Install via Kubernetes
• Install via Helm
• Install in Temporal Mode
• Install in Developer Mode

🤓 How do I use DevLake?

1. Set up DevLake

You can set up Apache DevLake by following our step-by-step instructions for Install via Docker Compose or Install via Kubernetes. Please see detailed instructions here, and ask the community if you get stuck at any point.

2. Create a Blueprint

The DevLake Configuration UI will guide you through the process (a Blueprint) to define the data connections, data scope, transformation and sync frequency of the data you wish to collect.

3. Track the Blueprint's progress

You can track the progress of the Blueprint you have just set up.

4. View the pre-built dashboards

Once the first run of the Blueprint is completed, you can view the corresponding dashboards.

5. Customize the dashboards with SQL

If the pre-built dashboards are limited for your use cases, you can always customize or create your own metrics or dashboards with SQL.

😍 How to Contribute

Please read the contribution guidelines before you make contribution. The following docs list the resources you might need to know after you decided to make contribution.

• Create an Issue: Report a bug or feature request to Apache DevLake
• Submit a PR: Start with good first issues or issues with no assignees
• Join Mailing list: Initiate or participate in project discussions on the mailing list
• Write a Blog: Write a blog to share your use cases about Apache DevLake
• Contribute a Plugin: Add a plugin to integrate Apache DevLake with more data sources for the community

📄 Contributing to Documentation:

• Apache DevLake's documentation is hosted at devlake.apache.org
• We have a separate GitHub repository for Apache DevLake's documentation: github.com/apache/incubator-devlake-website

⌚ Project Roadmap

• Roadmap 2022: Detailed project roadmaps for 2022.

💙 Community

• Slack: Message us on Slack
• FAQ: Frequently Asked Questions
• Wechat Community:
  

📄 License

This project is licensed under Apache License 2.0 - see the LICENSE file for details.