diff --git a/.dockerignore b/.dockerignore index a52e7ea2..9b1a7f5f 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,7 +1,6 @@ # server .editorconfig .git -docs/ README.md .env sqlite3.db diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml deleted file mode 100644 index 2539c04f..00000000 --- a/.github/workflows/publish-docs.yaml +++ /dev/null @@ -1,52 +0,0 @@ -name: publish-docs - -on: - deployment - -jobs: - publish-docs: - runs-on: ubuntu-latest - if: ${{ github.event.deployment.environment == 'docs' }} - steps: - - - uses: actions/checkout@v2 - - - name: Start to publish - uses: chrnorm/deployment-status@releases/v1 - with: - deployment_id: ${{ github.event.deployment.id }} - description: Start to publish docs. - state: "in_progress" - token: "${{ github.token }}" - - - name: Create requirements.txt - uses: "finnp/create-file-action@master" - env: - FILE_NAME: requirements.txt - FILE_DATA: | - pymdown-extensions==8.2 - - - name: Publish docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - GITHUB_TOKEN: ${{ secrets.DEPLOY_TOKEN }} - CUSTOM_DOMAIN: docs.gitploy.io - REQUIREMENTS: requirements.txt - - - name: Publish successfully - if: success() - uses: chrnorm/deployment-status@releases/v1 - with: - deployment_id: ${{ github.event.deployment.id }} - description: Succeed to publish. - state: "success" - token: "${{ github.token }}" - - - name: Publish failed - if: failure() - uses: chrnorm/deployment-status@releases/v1 - with: - deployment_id: ${{ github.event.deployment.id }} - description: Failed to publish. - state: "failure" - token: "${{ github.token }}" \ No newline at end of file diff --git a/docs/contributing.md b/CONTRIBUTING.md similarity index 100% rename from docs/contributing.md rename to CONTRIBUTING.md diff --git a/README.md b/README.md index 5a08fcc2..ebae7271 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Gitploy

-
+
Gitploy - Build the deployment system around GitHub in minutes. | Product Hunt Gitploy - Build the deployment system around GitHub in minutes. | Product Hunt
@@ -21,7 +21,7 @@ GitHub provides the [deployment API](https://docs.github.com/en/rest/reference/d Gitploy enables your organization **to build the deployment system around deployment API in minutes**, and it provides the place to manage all deployment and deploying in the same manner. -![gitploy](./docs/images/gitploy.gif) +![gitploy](./images/gitploy.gif) ## Features @@ -57,12 +57,8 @@ Documentation | Community | Installation Guide | Docker Image --- |--- |--- |--- 📚 [Documentation](https://www.gitploy.io/docs/) |❓ [Community](https://github.com/gitploy-io/gitploy/discussions) / 💬 [Slack](https://join.slack.com/t/gitploy/shared_invite/zt-112wz7qtz-HuZXMM_DaEEo1VDdsCUSRg)|📖 [Installation Guide](https://www.gitploy.io/docs/tasks/installation/) |🐋 [Docker Image](https://hub.docker.com/repository/docker/gitployio/gitploy) -### Articles - -* [Enterprise-level deployment system for Kubernetes](https://dev.to/hanjunlee/enterprise-level-deployment-system-for-kubernetes-6eg) - ## Contributors Don't be afraid to contribute! We have many things you can do to help out. If you're trying to contribute but stuck, please tag [@hanjunlee](https://github.com/hanjunlee). -You can check the [contributing](./docs/contributing.md) for exact details on how to contribute. +You can check the [contributing](./CONTRIBUTING.md) for exact details on how to contribute. diff --git a/deploy.yml b/deploy.yml index 12c53631..5dfd8d6e 100644 --- a/deploy.yml +++ b/deploy.yml @@ -21,9 +21,3 @@ envs: - hanjunlee - noah-qa deployable_ref: 'v.*\..*\..*' - - - name: docs - task: ${GITPLOY_DEPLOY_TASK:=rollback}:docs - auto_merge: false - description: Publish the documentation of Gitploy. - required_contexts: [] diff --git a/docs/concepts/deploy.yml.md b/docs/concepts/deploy.yml.md deleted file mode 100644 index 512f5b13..00000000 --- a/docs/concepts/deploy.yml.md +++ /dev/null @@ -1,99 +0,0 @@ -# deploy.yml - -Gitploy configures a pipeline with a simple, easy‑to‑read file that you commit to your git repository. The default path is `deploy.yml` at the root directory, but you can replace the file path in the settings tab of Gitploy. You can check the [documentation](../references/deploy.yml.md) for the specification of the configuration file and also references [Use Cases](../tasks/usecases.md). - -*⚠️ Note that the configuration file must be at the head of the default branch.* - -## Quick Start - -If you want to get started quickly, you should click the *New Configuration* link, copy the `deploy.yml` file, and push it into your git repository. Then you can find the `production` environment in Gitploy. - -```yaml -# deploy.yml -envs: - - name: production - auto_merge: false - # To avoid the context verification. - # required_context: [] -``` - -Figure) New Configuration Link - -![Quick Start](../images/quickstart.png) - -## Features -### Multi Environment - -For multi-environment, Gitploy provides you can make different pipelines for each environment, respectively. The configuration has to be defined under the `envs` field. The following example shows each environment has a different configuration. - -```yaml -envs: - # Development environment - - name: development - auto_merge: false - required_contexts: [] - - # Production environment - - name: production - auto_merge: true - required_contexts: - - test - - docker-image -``` - -### Parameters of GitHub deployment API - -Internally, Gitploy posts a deployment to GitHub [deployments API](https://docs.github.com/en/rest/reference/repos#create-a-deployment) with parameters from the configuration file. These parameters help you can verify the artifact before you start to deploy. The configuration provides fields to set all parameters of GitHub deployment API. You can check the [document](../references/deploy.yml.md) for the detail. - -```yaml -envs: - - name: production - task: deploy:lambda - description: Start deploying to the production. - auto_merge: false - required_contexts: - - test - - integration-test - production_environment: true -``` - -### Auto Deploy - -Gitploy provides not only manual deployment but also auto-deployment. Gitploy is listening for the push event dispatched from GitHub and triggers to deploy automatically when the ref is matched with the `auto_deploy_on` of the configuration file. - -```yaml -envs: - - name: production - auto_deploy_on: refs/heads/main - production_environment: true -``` - -### Deploy Freeze Window - -Gitploy support to add a window to prevent unintended deployment for the environment. You can freeze a window periodically by a cron expression. - -```yaml -envs: - - name: production - frozen_windows: - # Freeze every midnights - - start: "50 23 * * *" - duration: 20m - location: America/New_York - # Freeze every weekends - - start: "0 * * * SAT,SUN" - duration: 1h - location: Asia/Seoul -``` - -### Review - -Gitploy provides the review process. You can list up to users on the configuration file. You can check the [document](./review.md) for the detail. - -```yaml -envs: - - name: production - review: - enabled: true - reviewers: ["ocotocat", "noah"] -``` diff --git a/docs/concepts/deployment.md b/docs/concepts/deployment.md deleted file mode 100644 index 7011eddb..00000000 --- a/docs/concepts/deployment.md +++ /dev/null @@ -1,25 +0,0 @@ -# Deployment - -Gitploy provides two types of deployment: Deploy and Rollback. - -## Deploy - -Deploying is the primary feature of Gitploy. When you deploy, you have to select the environment and the reference. You can choose one of the environments defined in the configuration file (i.e. `deploy.yml`). You can select a commit, branch, or tag for reference. - -When you deploy the ref, Gitploy post the deployment to GitHub, and Github dispatch the event to external services. - -Figure) Deploy - -![deploy](../images/deploy.png) - -## Rollback - -Rollback is the best way to recover while you fix the problems, and Gitploy supports the rollback. You can choose one of the deployed references for the environment to roll back. - -When you roll back to the specific reference, Gitploy posts a new deployment with the reference from the rollbacked deployment. *Note that if the reference of the rollbacked deployment is a branch, Gitploy automatically references the commit SHA to avoid deploying the head of the branch.* - -For best practice, you should lock the environment to block deploying by others until finishing to fix the problems. Gitploy provide the 'lock' feature in UI and Chatops. - -Figure) Rollback - -![rollback](../images/rollback.png) \ No newline at end of file diff --git a/docs/concepts/how-it-work.md b/docs/concepts/how-it-work.md deleted file mode 100644 index cabfa4ac..00000000 --- a/docs/concepts/how-it-work.md +++ /dev/null @@ -1,44 +0,0 @@ -# How it works - -Gitploy builds the system around GitHub [deployment API](https://docs.github.com/en/rest/reference/deployments#deployments). **It's an event-driven decoupled way to deploy your code.** Internally, Gitploy creates a new Github deployment resource, and Github dispatches a deployment event that external services can listen for and act. It enables developers and organizations to build loosely coupled tooling. - -This approach has several pros: - -* Replace deployment tools easily without changing your deployment pipeline. -* Easy to implement details of deploying different types of applications (e.g., web, native). - -Below is a simple diagram for how these interactions would work: - -``` -+---------+ +--------+ +---------+ +-------------+ -| Gitploy | | GitHub | | Tools | | Your Server | -+---------+ +--------+ +---------+ +-------------+ - | | | | - | Create Deployment | | | - |--------------------->| | | - | | | | - | Deployment Created | | | - |<---------------------| | | - | | | | - | | Deployment Event | | - | |---------------------->| | - | | | SSH+Deploys | - | | |-------------------->| - | | | | - | | Deployment Status | | - | |<----------------------| | - | Deployment Status | | | - |<---------------------| | | - | | | | - | | | Deploy Completed | - | | |<--------------------| - | | Deployment Status | | - | |<----------------------| | - | Deployment Status | | | - |<---------------------| | | - | | | | -``` - -Gitploy lets you can build the advanced deployment system so your team and organization enable to deploy the application with lower risk and faster. - -*Keep in mind that Gitploy is never actually accessing your servers. It's up to your tools to interact with deployment events.* diff --git a/docs/concepts/license.md b/docs/concepts/license.md deleted file mode 100644 index 6679fb48..00000000 --- a/docs/concepts/license.md +++ /dev/null @@ -1,11 +0,0 @@ -# License - -## Community Edition - -Gitploy is an open source-based project so that anyone uses software under the OSS license free. You can check the [LICENSE](https://github.com/gitploy-io/gitploy/blob/main/LICENSE) for the detail. - -## Enterprise Edition - -Gitploy provides a non-commercial license. It is free for up to five members. *But if the count of members is over five, you have to consider purchasing the license to unlock the Gtiploy Enterprise edition.* To purchase, you can connect on the [enterprise page](https://www.gitploy.io/enterprise). - -After purchase, you can unlock the Gtiploy Enterprise edition by setting [the configuration](../references/GITPLOY_LICENSE.md). diff --git a/docs/concepts/lock.md b/docs/concepts/lock.md deleted file mode 100644 index 8bb92ce3..00000000 --- a/docs/concepts/lock.md +++ /dev/null @@ -1,7 +0,0 @@ -# Lock - -The worst thing that can happen is someone deploys to the same repository during an incident. The lock helps with this. We provide the locking system to block deployments going out to the environment. - -You can lock the environment simply by clicking the `LOCK` button in the UI. And if you want to reserve unlock, you can configure the auto-unlock timer. - -![lock](../images/lock.png) diff --git a/docs/concepts/metrics.md b/docs/concepts/metrics.md deleted file mode 100644 index 6679e105..00000000 --- a/docs/concepts/metrics.md +++ /dev/null @@ -1,45 +0,0 @@ -# Metrics - -Gtiploy publishes and exposes metrics that Prometheus can consume at the standard `/metrics` endpoint. - -## Configuration - -1\. Configure the server: - -``` -GITPLOY_PROMETHEUS_ENABLED=true -GITPLOY_PROMETHEUS_AUTH_SECRET=YOUR_SECRET -``` - -2\. Configure the prometheus scraper: - -```yaml -global: - scrape_interval: 60s - -scrape_configs: - - job_name: gitploy - authorization: - credentials: YOUR_SECRET - - static_configs: - - targets: ['domain.com'] -``` - -## Gitploy Metrics - -Gitploy provides the following Gitploy metrics. *Note that Some metrics are provided only for the production environment* (i.e. `production_environment: true` in the configuration file). - -* **gitploy_requests_total**
How many HTTP requests processed, partitioned by status code and HTTP method. -* **gitploy_request_duration_seconds**
The HTTP request latencies in seconds -* **gitploy_total_deployment_count**
The total deployment count of the production deployments. -* **gitploy_total_rollback_count**
The total rollback count of the production deployments. -* **gitploy_total_line_additions**
The total added lines of the production deployments. -* **gitploy_total_line_deletions**
The total deleted lines of the production deployments. -* **gitploy_total_line_changes**
The total changed lines of the production deployments. -* **gitploy_total_lead_time_seconds**
The total amount of time it takes a commit to get into the production environments. -* **gitploy_total_commit_count**
The total commit count of production deployments. -* **gitploy_member_count**
The total count of members. -* **gitploy_member_limit**
The limit count of members. -* **gitploy_total_active_repo_count**
The count of active repositories. -* **gitploy_total_repo_count**
The count of repositories. diff --git a/docs/concepts/notification.md b/docs/concepts/notification.md deleted file mode 100644 index aa09d51e..00000000 --- a/docs/concepts/notification.md +++ /dev/null @@ -1,18 +0,0 @@ -# Notification - -Gitploy notifies users when deployments and reviews are created or updated. Now, Gitploy supports browser notification and Slack. - -## Browser - -Gitploy provides the browser notification to alert events as default. Almost modern browsers provide [notification API](https://developer.mozilla.org/ko/docs/Web/API/notification), but unfortunately, some browsers are not supported. To avoid browser compatibility, you can replace it with Slack. - -*Note that if the notification doesn't work even though your browser provides it, you should check the setting that it is enabled or not.* - - -## Slack - -Slack is a popular messaging app for businesses globally. Gitploy supports Slack to notify events of deployments and reviews. You can figure out the Connect button on the settings page after integrating with Slack. Check [the documentation](../tasks/integration.md) for details. - -Figure) Slack notification - -![Slack Notification](../images/slack-notification.png) \ No newline at end of file diff --git a/docs/concepts/permission.md b/docs/concepts/permission.md deleted file mode 100644 index 02919a8e..00000000 --- a/docs/concepts/permission.md +++ /dev/null @@ -1,24 +0,0 @@ -# Permission - -Gitploy supports fine-grained access control for the repository. The user has explicit permissions(read, write, and admin) to the repository. - -## Synchronization -The permission of the repository is determined while Gitploy synchronizes with Github. *If the access permission has changed, you should re-synchronize it in Gitploy again.* - -## Capabilities - -Here are capabilities for each permission: - -* **Read** - Users can read all activities that happened in the repository, such as deployments, reviews. And users are also capable of responding to the review. - -* **Write** - Users can lock, deploy, and rollback. - -* **Admin** - Users can configures the repository, such as activating. - -Of course, write and admin permission cover the ability of read permission. - -## System admin - -The permission of the system admin can manage members of Gitploy. - -You can identify admin members by [GITPLOY_ADMIN_USERS](../references/GITPLOY_ADMIN_USERS.md). diff --git a/docs/concepts/review.md b/docs/concepts/review.md deleted file mode 100644 index af5d2d7c..00000000 --- a/docs/concepts/review.md +++ /dev/null @@ -1,29 +0,0 @@ -# Review - -Gitploy has the review to require at least one approval for the deployment. You can list up to reviewers on the configuration file. The reviewers must be logged in and have read permission for the repository. - -## Review process - -1\. To enable review, you must configure the `review` field first. - -```yaml -envs: - - name: production - review: - enabled: true - reviewers: ["USER_LOGIN1", "USER_LOGIN2"] -``` - -2\. When a user deploys in the 'deploy' tab, Gitploy automatically requests a review to reviewers. A reviewer should check what is changed from the latest one. - -![Changes](../images/changes.png) - -3\. Finally, a reviewer confirms to approve or reject the deployment, and the `deploy` button will be enabled if a reviewer approves. - -*I recommend that a reviewer use the `Approve and Deploy` to let a reviewer acknowledges that the deployment is started.* - -![Review](../images/review.png) - -## Notification - -Gitploy notifies users when a review is requested or responded to. You can check the [documentation](./notification.md) for the detail. \ No newline at end of file diff --git a/docs/concepts/self-hosted-server.md b/docs/concepts/self-hosted-server.md deleted file mode 100644 index 96999be6..00000000 --- a/docs/concepts/self-hosted-server.md +++ /dev/null @@ -1,5 +0,0 @@ -# Self-hosted Server - -Gitploy provides a self-hosted server, which is locally installed and hosted by the user, to provide complete control over your data at a lower cost. - -We're providing the [installation guide]((../tasks/installation.md)) for each environment. And if you meet across an issue please post questions or comments to our [community](https://github.com/gitploy-io/gitploy/discussions). diff --git a/docs/faq.md b/docs/faq.md deleted file mode 100644 index a89a187a..00000000 --- a/docs/faq.md +++ /dev/null @@ -1,9 +0,0 @@ -# FAQ - -**Q. I tried to deploy, and the deployment status has been pending as `created` for a while. How could I update it?** - -Don't worry. Gitploy transit the deployment status into `canceled` if pending (i.e. `created` or `waiting`) for thirty minutes. - -## Questions? - -We are always happy to help with questions you might have. Search our documentation or check out answers to common questions. You can also post questions or comments to our [community](https://github.com/gitploy-io/gitploy/discussions) or [Slack](https://join.slack.com/t/gitploy/shared_invite/zt-112wz7qtz-HuZXMM_DaEEo1VDdsCUSRg). diff --git a/docs/images/changes.png b/docs/images/changes.png deleted file mode 100644 index 636380e4..00000000 Binary files a/docs/images/changes.png and /dev/null differ diff --git a/docs/images/deploy.png b/docs/images/deploy.png deleted file mode 100644 index 88c24718..00000000 Binary files a/docs/images/deploy.png and /dev/null differ diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico deleted file mode 100644 index b65c4125..00000000 Binary files a/docs/images/favicon.ico and /dev/null differ diff --git a/docs/images/github-deployment.png b/docs/images/github-deployment.png deleted file mode 100644 index 019abbcf..00000000 Binary files a/docs/images/github-deployment.png and /dev/null differ diff --git a/docs/images/github-oauth.png b/docs/images/github-oauth.png deleted file mode 100644 index 60b2395a..00000000 Binary files a/docs/images/github-oauth.png and /dev/null differ diff --git a/docs/images/gitploy.png b/docs/images/gitploy.png deleted file mode 100644 index edfbaaa8..00000000 Binary files a/docs/images/gitploy.png and /dev/null differ diff --git a/docs/images/lock.png b/docs/images/lock.png deleted file mode 100644 index 5e5fb2f5..00000000 Binary files a/docs/images/lock.png and /dev/null differ diff --git a/docs/images/logo.svg b/docs/images/logo.svg deleted file mode 100644 index 476c4584..00000000 --- a/docs/images/logo.svg +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/docs/images/quickstart.png b/docs/images/quickstart.png deleted file mode 100644 index 78fee419..00000000 Binary files a/docs/images/quickstart.png and /dev/null differ diff --git a/docs/images/review.png b/docs/images/review.png deleted file mode 100644 index 3a4e8654..00000000 Binary files a/docs/images/review.png and /dev/null differ diff --git a/docs/images/rollback.png b/docs/images/rollback.png deleted file mode 100644 index 3a81b309..00000000 Binary files a/docs/images/rollback.png and /dev/null differ diff --git a/docs/images/slack-bot-token-scopes.png b/docs/images/slack-bot-token-scopes.png deleted file mode 100644 index 9ee1ca7d..00000000 Binary files a/docs/images/slack-bot-token-scopes.png and /dev/null differ diff --git a/docs/images/slack-notification.png b/docs/images/slack-notification.png deleted file mode 100644 index 83fc7668..00000000 Binary files a/docs/images/slack-notification.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index bfd63245..00000000 --- a/docs/index.md +++ /dev/null @@ -1,18 +0,0 @@ -# Gitploy - -## What is Gitploy? - -GitHub provides the [deployment API](https://docs.github.com/en/rest/reference/deployments#deployments) to deploy a specific ref(branch, SHA, tag). It enables your organization to build the deployment system loosely coupled tooling without worrying about the implementation details of delivering different types of applications (e.g., web, native). **But it takes a lot of resources to build the deployment system from scratch.** - -Gitploy enables your organization **to build the deployment system around deployment API in minutes**, and it provides the place to manage all deployment and deploying in the same manner. - -![gitploy](./images/gitploy.gif) - -## Features - -* Manage all deployments in one place. -* Provides the intuitive UI to deploy a specific `ref` (branch, SHA, tag). -* Build an event-driven deployment system for loosely coupled tooling. -* Provides both continuous delivery and continuous deployment. -* Provides advanced deployment features: Rollback, Review, Lock, Freeze Window. -* Provides DevOps metrics. diff --git a/docs/references/GITPLOY_ADMIN_USERS.md b/docs/references/GITPLOY_ADMIN_USERS.md deleted file mode 100644 index 77ec348e..00000000 --- a/docs/references/GITPLOY_ADMIN_USERS.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_ADMIN_USERS - -Optional comma-separated list of accounts, used to identify which accounts are admin. - -``` -GITPLOY_ADMIN_USERS=noah,liam -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_GITHUB_BASE_URL.md b/docs/references/GITPLOY_GITHUB_BASE_URL.md deleted file mode 100644 index 047bb819..00000000 --- a/docs/references/GITPLOY_GITHUB_BASE_URL.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_GITHUB_BASE_URL - -Optional string value configures the base URL for the GitHub enterprise. - -``` -GITPLOY_GITHUB_BASE_URL=https://github.gitploy.io/ -``` diff --git a/docs/references/GITPLOY_GITHUB_CLIENT_ID.md b/docs/references/GITPLOY_GITHUB_CLIENT_ID.md deleted file mode 100644 index 8536372e..00000000 --- a/docs/references/GITPLOY_GITHUB_CLIENT_ID.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_GITHUB_CLIENT_ID - -Required string value configures the GitHub OAuth client id. This is used to authorize access to GitHub on behalf of a Gitploy user. - -``` -GITPLOY_GITHUB_CLIENT_ID=05136f462e57d80189be -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_GITHUB_CLIENT_SECRET.md b/docs/references/GITPLOY_GITHUB_CLIENT_SECRET.md deleted file mode 100644 index 7d471586..00000000 --- a/docs/references/GITPLOY_GITHUB_CLIENT_SECRET.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_GITHUB_CLIENT_SECRET - -Required string value configures the GitHub OAuth client secret. This is used to authorize access to GitHub on behalf of a Gitploy user. - -``` -GITPLOY_GITHUB_CLIENT_SECRET=7c2245e9228a77d2cbddaa61ddc78d -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_GITHUB_SCOPES.md b/docs/references/GITPLOY_GITHUB_SCOPES.md deleted file mode 100644 index 1d8f9739..00000000 --- a/docs/references/GITPLOY_GITHUB_SCOPES.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_GITHUB_SCOPES - -Optional String value provides a comma-separated scopes of GitHub OAuth. The default values should not be modified. - -``` -GITPLOY_GITHUB_SCOPES=repo,read:user,read:org -``` diff --git a/docs/references/GITPLOY_LICENSE.md b/docs/references/GITPLOY_LICENSE.md deleted file mode 100644 index 36fdf9d6..00000000 --- a/docs/references/GITPLOY_LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_LICENSE - -Optional string value provides the license key. This is used to unlock the Gtiploy Enterprise edition. - -``` -GITPLOY_LICENSE=eyJtZW1lYmVyX2xpbWl0Ijo1LCJleHBpcmVkX2F0IjoiMjAyMi0wOC0yMlQxNjo0OToxNC42MDUxMjQrMDk6MDAifQ -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_MEMBER_ENTRIES.md b/docs/references/GITPLOY_MEMBER_ENTRIES.md deleted file mode 100644 index 33c19228..00000000 --- a/docs/references/GITPLOY_MEMBER_ENTRIES.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_MEMBER_ENTRIES - -Optional comma-separated list of accounts, used to limit to users in this list, or users that are members of organizations included in this list. - -``` -GITPLOY_MEMBER_ENTRIES=octocat,gitploy-io -``` diff --git a/docs/references/GITPLOY_ORGANIZATION_ENTRIES.md b/docs/references/GITPLOY_ORGANIZATION_ENTRIES.md deleted file mode 100644 index 7da13a3f..00000000 --- a/docs/references/GITPLOY_ORGANIZATION_ENTRIES.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_ORGANIZATION_ENTRIES - -Optional comma-separated list of organizations, used to limit which organization(or owner) are syncronized between your source control management system and Gitploy. *Note that this variable must be set before your first login. If you don't set this environment it synchronize with all repositories the user owns. - -``` -GITPLOY_ORGANIZATION_ENTRIES=gitploy-io,octocat,facebook -``` diff --git a/docs/references/GITPLOY_PROMETHEUS_AUTH_SECRET.md b/docs/references/GITPLOY_PROMETHEUS_AUTH_SECRET.md deleted file mode 100644 index 37815f7d..00000000 --- a/docs/references/GITPLOY_PROMETHEUS_AUTH_SECRET.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_PROMETHEUS_AUTH_SECRET - -Optional string value to authorize the scrape request from the Prometheus. *It authorizes with the `Authorization` header on request.* - -``` -GITPLOY_PROMETHEUS_AUTH_SECRET=92e6c41f002e71bf84e6c6b02e4c1e1b -``` diff --git a/docs/references/GITPLOY_PROMETHEUS_ENABLED.md b/docs/references/GITPLOY_PROMETHEUS_ENABLED.md deleted file mode 100644 index d735729c..00000000 --- a/docs/references/GITPLOY_PROMETHEUS_ENABLED.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_PROMETHEUS_ENABLED - -Optional string value to enable exposing metrics that Prometheus can consume. The default value is `false`. - -``` -GITPLOY_PROMETHEUS_ENABLED=true -``` diff --git a/docs/references/GITPLOY_PROXY_SERVER_HOST.md b/docs/references/GITPLOY_PROXY_SERVER_HOST.md deleted file mode 100644 index 42bbbb94..00000000 --- a/docs/references/GITPLOY_PROXY_SERVER_HOST.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_PROXY_SERVER_HOST - -Optional string value used to create webhooks that are routed through an alternate proxy server. The use case of this setting is that you need GitHub webhooks to route through a public proxy. - -``` -GITPLOY_PROXY_SERVER_HOST=external.cloud.gitploy.io -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_PROXY_SERVER_PROTO.md b/docs/references/GITPLOY_PROXY_SERVER_PROTO.md deleted file mode 100644 index 429105d9..00000000 --- a/docs/references/GITPLOY_PROXY_SERVER_PROTO.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_PROXY_SERVER_PROTO - -Optional string value used to create webhooks that are routed through an alternate proxy server. The use case of this setting is that you need GitHub webhooks to route through a public proxy. It can be one of them: `http` or `https`. - -``` -GITPLOY_PROXY_SERVER_PROTO=https -``` diff --git a/docs/references/GITPLOY_SERVER_HOST.md b/docs/references/GITPLOY_SERVER_HOST.md deleted file mode 100644 index bb3348eb..00000000 --- a/docs/references/GITPLOY_SERVER_HOST.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_SERVER_HOST - -Required string value configures the user-facing hostname. This value is used to create webhooks and redirect urls. It has no actual impact on serving traffic. - -``` -GITPLOY_SERVER_HOST=cloud.gitploy.io -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_SERVER_PROTO.md b/docs/references/GITPLOY_SERVER_PROTO.md deleted file mode 100644 index 38cfdec0..00000000 --- a/docs/references/GITPLOY_SERVER_PROTO.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_SERVER_PROTO - -Optional string value configures the user-facing protocol. This value is used to create webhooks and redirect urls. It can be one of them: `http` or `https`, and the default value is `https`. - -``` -GITPLOY_SERVER_PROTO=https -``` diff --git a/docs/references/GITPLOY_SLACK_CLIENT_ID.md b/docs/references/GITPLOY_SLACK_CLIENT_ID.md deleted file mode 100644 index 7931e554..00000000 --- a/docs/references/GITPLOY_SLACK_CLIENT_ID.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_SLACK_CLIENT_ID - -Optional string value configures the Slack OAuth client id. This is used to retrieve the bot token. - -``` -GITPLOY_SLACK_CLIENT_ID=21501117479.21586613311226 -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_SLACK_CLIENT_SECRET.md b/docs/references/GITPLOY_SLACK_CLIENT_SECRET.md deleted file mode 100644 index 6c692104..00000000 --- a/docs/references/GITPLOY_SLACK_CLIENT_SECRET.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_SLACK_CLIENT_SECRET - -Optional string value configures the Slack OAuth client secret. This is used to retrieve the bot token. - -``` -GITPLOY_SLACK_CLIENT_SECRET=6589c9644df4e12a7f88d3e7ce0ae6 -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_STORE_DRIVER.md b/docs/references/GITPLOY_STORE_DRIVER.md deleted file mode 100644 index 38f24f87..00000000 --- a/docs/references/GITPLOY_STORE_DRIVER.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_STORE_DRIVER - -String value provides the driver of store. It supports `sqlite3`, `mysql`, and `postgres`. The default value is `sqlite3`. - -``` -GITPLOY_STORE_DRIVER=mysql -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_STORE_SOURCE.md b/docs/references/GITPLOY_STORE_SOURCE.md deleted file mode 100644 index f26af077..00000000 --- a/docs/references/GITPLOY_STORE_SOURCE.md +++ /dev/null @@ -1,19 +0,0 @@ -# GITPLOY_STORE_SOURCE - -String value provides the source of store. Configures the database connection string. The default value is the path of the embedded sqlite3 database file. - -``` -GITPLOY_STORE_SOURCE=file:/data/sqlite3.db?cache=shared&_fk=1 -``` - -Example mysql connection string (below). See the official driver [documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for more connection string details. - -``` -GITPLOY_STORE_SOURCE=root:password@tcp(1.2.3.4:3306)/gitploy?parseTime=true -``` - -Example postgres connection string (below). See the official driver [documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) for more connection string details. - -``` -GITPLOY_STORE_SOURCE=postgres://root:password@1.2.3.4:5432/gitploy?sslmode=disable -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_TLS_CERT.md b/docs/references/GITPLOY_TLS_CERT.md deleted file mode 100644 index f573c58b..00000000 --- a/docs/references/GITPLOY_TLS_CERT.md +++ /dev/null @@ -1,9 +0,0 @@ -# GITPLOY_TLS_CERT - -Path to an SSL certificate used by the server to accept HTTPS requests. This parameter is of type string and is optional. - -Please note that the cert file should be the concatenation of the server’s certificate, any intermediates, and the certificate authority’s certificate. - -``` -GITPLOY_TLS_CERT=/path/to/cert.pem -``` \ No newline at end of file diff --git a/docs/references/GITPLOY_TLS_KEY.md b/docs/references/GITPLOY_TLS_KEY.md deleted file mode 100644 index 7cff34e4..00000000 --- a/docs/references/GITPLOY_TLS_KEY.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_TLS_KEY - -Path to an SSL certificate key used by the server to accept HTTPS requests. This configuration parameter is of type string and is optional. - -``` -GITPLOY_TLS_KEY=/path/to/key.pem -``` diff --git a/docs/references/GITPLOY_WEBHOOK_SECRET.md b/docs/references/GITPLOY_WEBHOOK_SECRET.md deleted file mode 100644 index 962ce31c..00000000 --- a/docs/references/GITPLOY_WEBHOOK_SECRET.md +++ /dev/null @@ -1,7 +0,0 @@ -# GITPLOY_WEBHOOK_SECRET - -Optional string value to create an http-signature for the webhook. The webhook recipient use this secret to verify request authenticity. - -``` -GITPLOY_WEBHOOK_SECRET=ae354839ad94078b9ea125eec4874370 -``` diff --git a/docs/references/configurations.md b/docs/references/configurations.md deleted file mode 100644 index c27d2251..00000000 --- a/docs/references/configurations.md +++ /dev/null @@ -1,25 +0,0 @@ -# Configurations - -Index of server configuration settings: - -* [GITPLOY_ADMIN_USERS](./GITPLOY_ADMIN_USERS.md) -* [GITPLOY_GITHUB_BASE_URL](./GITPLOY_GITHUB_BASE_URL.md) -* [GITPLOY_GITHUB_CLIENT_ID](./GITPLOY_GITHUB_CLIENT_ID.md) -* [GITPLOY_GITHUB_CLIENT_SECRET](./GITPLOY_GITHUB_CLIENT_SECRET.md) -* [GITPLOY_GITHUB_SCOPES](./GITPLOY_GITHUB_SCOPES.md) -* [GITPLOY_LICENSE](./GITPLOY_LICENSE.md) -* [GITPLOY_MEMBER_ENTRIES](./GITPLOY_MEMBER_ENTRIES.md) -* [GITPLOY_PROMETHEUS_AUTH_SECRET](./GITPLOY_PROMETHEUS_AUTH_SECRET.md) -* [GITPLOY_PROMETHEUS_ENABLED](./GITPLOY_PROMETHEUS_ENABLED.md) -* [GITPLOY_ORGANIZATION_ENTRIES](./GITPLOY_ORGANIZATION_ENTRIES.md) -* [GITPLOY_PROXY_SERVER_HOST](./GITPLOY_PROXY_SERVER_HOST.md) -* [GITPLOY_PROXY_SERVER_PROTO](./GITPLOY_PROXY_SERVER_PROTO.md) -* [GITPLOY_SERVER_HOST](./GITPLOY_SERVER_HOST.md) -* [GITPLOY_SERVER_PROTO](./GITPLOY_SERVER_PROTO.md) -* [GITPLOY_SLACK_CLIENT_ID](./GITPLOY_SLACK_CLIENT_ID.md) -* [GITPLOY_SLACK_CLIENT_SECRET](./GITPLOY_SLACK_CLIENT_SECRET.md) -* [GITPLOY_STORE_DRIVER](./GITPLOY_STORE_DRIVER.md) -* [GITPLOY_STORE_SOURCE](./GITPLOY_STORE_SOURCE.md) -* [GITPLOY_TLS_CERT](./GITPLOY_TLS_CERT.md) -* [GITPLOY_TLS_KEY](./GITPLOY_TLS_KEY.md) -* [GITPLOY_WEBHOOK_SECRET](./GITPLOY_WEBHOOK_SECRET.md) diff --git a/docs/references/deploy.yml.md b/docs/references/deploy.yml.md deleted file mode 100644 index 9a32685d..00000000 --- a/docs/references/deploy.yml.md +++ /dev/null @@ -1,62 +0,0 @@ -# deploy.yml - - -Field |Type |Required |Description ---- |---- |--- |--- -`envs` |*[][Env](#env)* |`true` |Thie field configures the pipeline for each environment, respectively. - -## Env - - -Field |Type |Required |Description ---- |---- |--- |--- -`name` |*string* |`true` |This field is the runtime environment such as `production`, `staging`, and `qa`. -`task` |*string* |`false` |This field is used by the deployment system to distinguish the kind of deployment. (*Only for `GitHub`*) -`description` |*string* |`false` |This field is the short description of the deployment. (*Only for `GitHub`*) -`auto_merge` |*boolean* |`false` |This field is used to ensure that the requested ref is not behind the repository's default branch. If you deploy with the commit or the tag you need to set `false`. For rollback, Gitploy set the field `false`. (*Only for `GitHub`*) -`required_contexts` |*[]string* |`false` |This field allows you to specify a subset of contexts that must be success. (*Only for `GitHub`*) -`payload` |*object* or *string* |`false` |This field is JSON payload with extra information about the deployment. (*Only for `GitHub`*) -`production_environment` |*boolean* |`false` |This field specifies whether this runtime environment is production or not. -`deployable_ref` |*string* |`false` |This field specifies which the ref(branch, SHA, tag) is deployable or not. It supports the regular expression ([re2]((https://github.com/google/re2/wiki/Syntax))). -`auto_deploy_on` |*string* |`false` |This field controls auto-deployment behaviour given a ref(branch, SHA, tag). If any new push events are detected on this event, the deployment will be triggered. It supports the regular expression ([re2](https://github.com/google/re2/wiki/Syntax)). E.g. `refs/heads/main` or `refs/tags/v.*` -`review` |*[Review](#review)* |`false` |This field configures reviewers. -`frozen_windows` |*[][Frozen Window](#frozen-window)* |`false` |This field configures to add a frozen window to prevent unintended deployment for the environment. - -## Review - -Field |Type |Required |Description ---- |--- |--- |--- -`enabled` |*boolean* |`false` |This field makes to enables the review feature. The default value is `false`. -`reviewers` |*[]string* |`false` |This field list up reviewers. The default value is `[]`. You should specify the maintainers of the project. - -## Frozen Window - -Field |Type |Required |Description ---- |--- |--- |--- -`start` |*string* |`true` |This field is a cron expression to indicate when the window starts. For example, `55 23 * * *` means it starts to freeze a window before 5 minutes of midnight. You can check the [documentation](https://github.com/gitploy-io/cronexpr) for details. -`duration` |*string* |`true` |This field configures how long the window is frozen from the starting. The duration string is a possibly signed sequence of decimal numbers and a unit suffix such as `5m`, or `1h30m`. Valid time units are `ns`, `us`, `ms`, `s`, `m`, `h`. -`location` |*string* |`false` |This field configures the location of the `start` time. The value is taken to be a location name corresponding to a file in the IANA Time Zone database, such as `America/New_York`. The default value is `UTC`. You can check the [document](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the Time Zone database name. - -## Variables - -The following variables are available in `${ }` syntax when evaluating `deploy.yml` before deploy or rollback: - -* `GITPLOY_DEPLOY_TASK`: Returns `deploy` for deploy, but rollback, it returns the empty string. -* `GITPLOY_ROLLBACK_TASK`: Returns `rollback` for rollback, but deploy, it returns the empty string. -* `GITPLOY_IS_ROLLBACK`: Returns `true` for rollback, but deploy, it returns `false`. - -Example usage of this: - -```yaml -envs: - - name: prod - task: "${GITPLOY_DEPLOY_TASK}${GITPLOY_ROLLBACK_TASK}:kubernetes" # It returns "deploy:kubernetes" or "rollback:kubernetes" -``` - -And Gitploy provides the string operation to facilitate customized values. You can check supported functions at [here](https://github.com/drone/envsubst). - -```yaml -envs: - - name: prod - task: "${GITPLOY_DEPLOY_TASK=rollback}:kubernetes" # It returns "deploy:kubernetes" or "rollback:kubernetes" -``` diff --git a/docs/tasks/database.md b/docs/tasks/database.md deleted file mode 100644 index eca16d0b..00000000 --- a/docs/tasks/database.md +++ /dev/null @@ -1,31 +0,0 @@ -# Database - -Gitploy requires the use of a database backend for persistence. Gitploy uses an embedded SQLite database by default. This article provides alternate databases: MySQL and Postgres. - -## MySQL - -Gitploy supports mysql `5.6` and higher as the database engine. The below example demonstrates mysql database configuration. See the official driver [documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for more connection string details. - -``` -GITPLOY_STORE_DRIVER=mysql -GITPLOY_STORE_SOURCE=root:password@tcp(1.2.3.4:3306)/gitploy?parseTime=true -``` - -### *⚠️ WARNING* - -You have to setting the SQL mode by removing `NO_ZERO_DATE` from the default setting to enable the zero value for the `timestamp` type. - -``` -sql-mode='ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION' -``` - -To set the SQL mode, you can check the official [document](https://dev.mysql.com/doc/refman/8.0/en/sql-mode.html). - -## Postgres - -Gitploy supports postgres on the following 4 versions: `10`, `11`, `12` and `13`. The below example demonstrates postgres database configuration. See the official driver [documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING) for more connection string details. - -``` -GITPLOY_STORE_DRIVER=postgres -GITPLOY_STORE_SOURCE=root:password@1.2.3.4:5432/gitploy?sslmode=disable -``` diff --git a/docs/tasks/installation.md b/docs/tasks/installation.md deleted file mode 100644 index 9efb82a4..00000000 --- a/docs/tasks/installation.md +++ /dev/null @@ -1,137 +0,0 @@ -# Installation - -This article explains how to install the Gitploy server for GitHub. - -## Step 1: Preparation - -### Provision an instance - -The server should be installed on a server or virtual machine with standard http and https ports open. - -### Create an OAuth Application - -[Create a GitHub OAuth application.](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) The Client Key and Client Secret are used to authorize access to GitHub resources. - -*The authorization callback URL must match with the format:* `GITPLOY_SERVER_PROTO://GITPLOY_SERVER_HOST/signin`. - -Figure) Github OAuth - -![Github OAuth](../images/github-oauth.png) - -## Step 2: Configuration - -The server is configured using environment variables. This article only configures with least environment. See [Configurations](../references/configurations.md) for a complete list of configuration options. - -* **GITPLOY_SERVER_HOST**: -Required string value configures the user-facing hostname. This value is used to create webhooks and redirect urls. - -* **GITPLOY_SERVER_PROTO**: -Optional string value configures the user-facing protocol. This value is used to create webhooks and redirect urls. It can be one of them: `http` or `https`, and the default value is `https`. - -* **GITPLOY_GITHUB_CLIENT_ID**: -Required string value configures the GitHub OAuth client id. This is used to authorize access to GitHub on behalf of a Gitploy user. - -* **GITPLOY_GITHUB_CLIENT_SECRET**: -Required string value configures the GitHub OAuth client secret. This is used to authorize access to GitHub on behalf of a Gitploy user. - -## Step 3: Start server - -### Docker - -The server is distributed as a Docker image. The image is self-contained and does not have any external dependencies. We recommend to use the last version. - -``` -docker pull gitployio/gitploy:0.5 -``` - -The server container can be started with the below command. The container is configured through environment variables. - -```shell -docker run \ - --volume=/var/lib/gitploy:/data \ - --env=GITPLOY_SERVER_HOST={{GITPLOY_SERVER_HOST}} \ - --env=GITPLOY_SERVER_PROTO={{GITPLOY_SERVER_PROTO}} \ - --env=GITPLOY_GITHUB_CLIENT_ID={{GITPLOY_GITHUB_CLIENT_ID}} \ - --env=GITPLOY_GITHUB_CLIENT_SECRET={{GITPLOY_GITHUB_CLIENT_SECRET}} \ - --publish=80:80 \ - --publish=443:443 \ - --restart=always \ - --detach=true \ - --name=gitploy \ - gitployio/gitploy:0.5 -``` - -### Kubernetes - -The server can be started in Kubernetes with the below artifacts. The container is configured through environment variables. - -And we’re also support the official Helm chart to install the server, check [here](https://github.com/gitploy-io/helm-chart) for details. - -

-Kubernetes YAML - -```yaml -apiVersion: v1 -kind: Service -metadata: - name: gitploy - labels: - app.kubernetes.io/name: gitploy -spec: - type: ClusterIP - ports: - - port: 80 - targetPort: http - protocol: TCP - name: http - selector: - app.kubernetes.io/name: gitploy ---- -apiVersion: apps/v1 -kind: Deployment -metadata: - name: gitploy - labels: - app.kubernetes.io/name: gitploy -spec: - replicas: 1 - selector: - matchLabels: - app.kubernetes.io/name: gitploy - template: - metadata: - labels: - app.kubernetes.io/name: gitploy - spec: - containers: - - name: gitploy-server - image: "gitployio/gitploy:0.5" - imagePullPolicy: IfNotPresent - ports: - - name: http - containerPort: 80 - protocol: TCP - # Fill out values of environments - env: - - name: GITPLOY_SERVER_HOST - value: "" - - name: GITPLOY_SERVER_PROTO - value: "" - - name: GITPLOY_GITHUB_CLIENT_ID - value: "" - - name: GITPLOY_GITHUB_CLIENT_SECRET - value: "" -``` -
- -## Pro tips - -### Persistence - -Gitploy uses an embedded SQLite database by default, and it stores all of the data in a single file. For persistence, you have to attach the volume to the path of the database (i.e., [GITPLOY_STORE_SOURCE](../references/GITPLOY_STORE_SOURCE.md)) in the container. You can check the [example](https://docs.docker.com/get-started/05_persisting_data/#persist-the-todo-data) on how to mount the volume in Docker. - -And if you need alternative database, MySQL and Postgres, you should check the [database](database.md) documentation. - -### Security - -The server receives the webhook through the internet, and it could be a security issue. So you probably want to limit requests to those coming from GitHub. To ensure your server is only receiving the expected GitHub request, you must configure the secret token. You can configure it by [GITPLOY_WEBHOOK_SECRET](../references/GITPLOY_WEBHOOK_SECRET.md). diff --git a/docs/tasks/integration.md b/docs/tasks/integration.md deleted file mode 100644 index 807090a2..00000000 --- a/docs/tasks/integration.md +++ /dev/null @@ -1,52 +0,0 @@ -# Integration - -## GitHub Action - -GitHub Actions help you automate tasks to run an actual deployment. GitHub Actions are event-driven, meaning that you can run a series of commands after a deployment event has occurred. - -You must specify `deployment` for the `on` field to listen for the deployment event. And you can use the `if` conditional to run a job for a specific environment. Here is the example below. - -```yaml -# Listening the deployment event -on: - deployment - -jobs: - deploy-dev: - runs-on: ubuntu-latest - # Run a job when the environment is 'production. - if: ${{ github.event.deployment.environment == 'production' }} - steps: - - - name: Checkout - uses: actions/checkout@v2 - - - name: Start to deploy - uses: chrnorm/deployment-status@releases/v1 - with: - deployment_id: ${{ github.event.deployment.id }} - description: Start to deploy ... - state: "in_progress" - token: "${{ github.token }}" - # Run your deployment commands. -``` - -## Slack - -Slack integration provides notifications for events. - -### Step 1: Create App - -Firstly, we have to create [Slack App](https://api.slack.com/apps). You should click the Create App button and fill out inputs. - -### Step 2: Configure Permissions - -After creating App, we move to the *OAuth & Permissions* page and set up *the redirect URLs* and *Bot Token scopes*on this page. Firstly, you should add a new redirect URL with the `GITPLOY_SERVER_PROTO://GITPLOY_SERVER_HOST/slack/signin` format; secondly, add `chat:write` scope into the Bot Token scopes. - -Figure) Slack Bot Token Scopes - -![Slack Bot Token Sceops](../images/slack-bot-token-scopes.png) - -### Step 3: Run Server With App Credentials - -To enable Slack integration, you have to set up these environments when you run the server: `GITPLOY_SLACK_CLIENT_ID` and `GITPLOY_SLACK_CLIENT_SECRET`. You can get these credentials from *App Credentials* section of *Basic Information* page. diff --git a/docs/tasks/usecases.md b/docs/tasks/usecases.md deleted file mode 100644 index f0d8a27a..00000000 --- a/docs/tasks/usecases.md +++ /dev/null @@ -1,52 +0,0 @@ -# Use Cases - -## Deploying the head of the `main` branch - -The general way of deployment is deploying the head of the `main` branch that has only verified commits. To constrain deploying only the head of the `main` branch, we can use the `auto_merge` parameter of GitHub [deployment API](https://docs.github.com/en/rest/reference/repos#create-a-deployment) to ensure that the deployment is the head of the branch, and set `deployable_ref` field with the `main`. - -```yaml -envs: - - name: production - auto_merge: true - deployable_ref: main - production_environment: true -``` - -## Deploying with the version - -The versioning is the general way to specify the artifact or the commit, and GitHub provides the release page for versioning. If your team (or organization) wants to constrain deploying with the version, you can use the `deployable_ref` field like below. - -```yaml -envs: - - name: production - auto_merge: false - deployable_ref: 'v.*\..*\..*' # Semantic versioning - production_environment: true -``` - -## Deploying the artifact - -The artifact could be a binary file from compiling source codes or a docker image, which means we have to build the artifact before we deploy. The commit status is the best way to verify if the artifact exists or not. The builder, such as GitHub Action or Circle CI, posts the commit status after building the artifact, and we can verify it by the `required_contexts` parameter when we deploy. You can reference the `deploy.yml` of Gitploy. - -```yaml -envs: - - name: production - auto_merge: false - required_contexts: - - "publish-image" # The commit status of building the artifact. - production_environment: true -``` - -## Auto deployment - -If you want to enable the auto-deployment when the pull request is merged into the main branch, you should configure the `auto_deploy_on` field like the below. - -```yaml -envs: - - name: production - auto_merge: true - required_contexts: [] - auto_deploy_on: refs/heads/main - deployable_ref: main - production_environment: true -``` diff --git a/docs/images/gitploy.gif b/images/gitploy.gif similarity index 100% rename from docs/images/gitploy.gif rename to images/gitploy.gif diff --git a/docs/images/logo_400.png b/images/logo.png similarity index 100% rename from docs/images/logo_400.png rename to images/logo.png diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 2c37c60c..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,50 +0,0 @@ -site_name: Gitploy -site_url: https://doc.gitploy.io -theme: - name: material - palette: - primary: deep purple - accent: deep purple - logo: images/logo.svg - favicon: images/favicon.ico - icon: - repo: fontawesome/brands/github -nav: - - Home: index.md - - Concepts: - - "How it works": concepts/how-it-work.md - - "deploy.yml": concepts/deploy.yml.md - - Deployment: concepts/deployment.md - - Review: concepts/review.md - - Lock: concepts/lock.md - - Permission: concepts/permission.md - - Notification: concepts/notification.md - - Metrics: concepts/metrics.md - - License: concepts/license.md - - "Self-hosted Server": concepts/self-hosted-server.md - - Tasks: - - Installation: tasks/installation.md - - Database: tasks/database.md - - "Use Cases": tasks/usecases.md - - Integration: tasks/integration.md - - References: - - Configurations: references/configurations.md - - "deploy.yml": references/deploy.yml.md - - FAQ: faq.md - - Contributing: contributing.md -extra: - social: - - icon: fontawesome/brands/github - link: https://github.com/gitploy-io - version: - provider: mike - analytics: - provider: google - property: G-7T0YFTQSFV -copyright: Copyright © 2021 Gitploy.IO -repo_name: gitploy-io/gitploy -repo_url: https://github.com/gitploy-io/gitploy -edit_uri: edit/main/docs/ -markdown_extensions: - - pymdownx.highlight - - pymdownx.superfences