|
1 | 1 | # Gitploy
|
2 | 2 |
|
3 |
| - |
| 3 | +  |
4 | 4 |
|
5 |
| - |
| 5 | +<p align="center"> |
| 6 | + <img src="./docs/images/logo_400.png"><br/> |
| 7 | + <b>Gitploy helps your team build the deployment system around GitHub in minutes.</b><br/> |
| 8 | + <a href="https://docs.gitploy.io/">Documentation</a> | <a href="https://github.com/gitploy-io/gitploy/discussions">Community</a> | <a href="https://docs.gitploy.io/tasks/installation/">Installation Guide</a> |
| 9 | +</p> |
| 10 | + |
| 11 | +--- |
6 | 12 |
|
7 | 13 | ## What is Gitploy?
|
8 | 14 |
|
9 |
| -Gitploy helps your team or organization builds the system around GitHub in minutes. Gitploy provides these features: |
| 15 | +GitHub provides [deployment API](https://docs.github.com/en/rest/reference/repos#deployments) to deploy a specific ref(branch, SHA, tag). It offers strong features to make your team (or organization) can deploy fast and safety. But it takes a lot of resources to build the tool with GitHub deployment API. |
| 16 | + |
| 17 | +Gitploy makes your team or organization build the deployment system around GitHub in minutes. Now, do not waste the time to build the deployment system. |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | + |
| 22 | +## Features |
| 23 | + |
| 24 | +* Provides the intuitive UI to deploy a specific ref (branch, SHA, tag). |
| 25 | +* Build an event-driven deployment system around GitHub. See GitHub [deployment event](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment). |
| 26 | +* Integrate with GitHub [Action](https://github.com/features/actions) in minutes. |
| 27 | +* Provides deployment features: Rollback, Review, Lock. |
| 28 | +* Provides various validations for the deployment. |
| 29 | +* Provides DevOps metrics. |
| 30 | + |
| 31 | +## Gitploy vs GitHub environment |
10 | 32 |
|
11 |
| -* Deploy a specific ref (branch, commit, tag) |
12 |
| -* Build an event-driven deployment system around GitHub [deployment API](https://docs.github.com/en/rest/reference/repos#deployments) |
13 |
| -* Integrate with GitHub [Action](https://github.com/features/actions) in minutes |
| 33 | +Name | Gitploy | GitHub environment |
| 34 | +--- |--- |--- |
| 35 | +Manual deploy | ✅ | ✅ |
| 36 | +Review | ✅ | ✅ |
| 37 | +Rollback | ✅ | ❌ |
| 38 | +Lock environment | ✅ | ❌ |
| 39 | +Commit statuses validation | ✅ | ❌ |
| 40 | +Display changed commmits | ✅ | ❌ |
| 41 | +Private repositories for teams plan | ✅ | ❌ (Enterprise Only) |
14 | 42 |
|
15 |
| -If you want to look around, you can check the [document](https://docs.gitploy.io) of Gitploy. |
| 43 | +## Getting Started |
16 | 44 |
|
17 |
| -## Docs and Support |
| 45 | +To install Gitploy on your hosting, read this [documentation](https://docs.gitploy.io/tasks/installation/). |
18 | 46 |
|
19 |
| -The documentation to use Gitploy is available at: https://docs.gitploy.io |
| 47 | +For public repositories, we're providing the [free cloud](https://github.com/marketplace/gtiploy). |
20 | 48 |
|
21 |
| -For discussions and questions, post questions or comments to our [community](https://github.com/gitploy-io/gitploy/discussions). |
| 49 | +### Important Links |
22 | 50 |
|
23 |
| -For bugs or errors, [open an issue](https://github.com/gitploy-io/gitploy/issues/new/choose) with details. |
| 51 | +Documentation | Community | Installation Guide | Docker Image |
| 52 | +--- |--- |--- |--- |
| 53 | +📚 [Documentation](https://docs.gitploy.io/) |💬 [Community](https://github.com/gitploy-io/gitploy/discussions) |📖 [Installation Guide](https://docs.gitploy.io/tasks/installation/) |🐋 [Docker Image](https://hub.docker.com/repository/docker/gitployio/gitploy) |
24 | 54 |
|
25 |
| -## Community |
| 55 | +## Contributors |
26 | 56 |
|
27 |
| -You can visit us at Github [Discussions](https://github.com/gitploy-io/gitploy/discussions). |
| 57 | +TBD |
0 commit comments