• #115
• #117

We should provide the community edition to personal users and small teams. The core logic would be the same with the enterprise edition, but some features are only supported for the enterprise edition.

We plan to use tags such as oss to build with OSS files when we compile them into the binary file.

Specify which organizations synchronized between Github and Gitploy.

Initialize the documentation with Mkdocx and material theme.

Here are good references of documentations:

• Kubernetes

We should provide some features to enhance the review system.

Note

When I started to design the review system, I thought it was reasonable to deploy automatically after approval like GitHub. But for Gitploy, it is not feasible because Gitploy has the validation of GitHub deployment API, which can fail to deploy automatically. So we should deploy it manually.

Todo

• #201
• #197

• Show rate-limiting for API call
• Admin information

Schema

We should add a new schema comment like below:

Relation

deployment --< comment >-- user

Table

Only interactor have to handle the business logic of Gitploy to prevent confusion.

Add more metrics of deployment for DevOps from the article. Metrics should represent velocity, quality, and application performance.

Metrics

• Frequency: #153 (The count of deployment)
• Size: The count of commits, The count of changed lines, and The count of files.
• Performance: The rate of size for a deployment.

Subtasks

• #168
• #169
• Add metrics for the lead time of commits

It displays the branch with the commit SHA such as main(3223ee) or main(latest).

It should display changes from the previous one in the deployment view, and also if the approve button is supported by Chat it should display changes with a message.

• Deployment Page #12
• Slack Approval Requested

Restrict REF only matched with the pattern. For example, deployable_ref: main means only the main branch is deployable to the environment.

# in deploy.yml

deployable_ref: main

Objectives

Gitploy V1 provides what users need to build an delivery pipeline.

Roadmap

• Advanced Deployment
  • #217
  • #98
  • #377
  • Support the continuous deployment (Auto deploy periodically)
  • Support configuration template
  • #379
• Deployment Safety
  • #33
  • #368
  • #269
  • Restrict admin permission to a critical environment
• Review
  • #188
  • #185
  • Provide the field for the template of a review comment
• Support gitploy CLI
  • #219
  • #446
  • #354
• Lock the repository to block deploying
  • #83
  • #114
  • #155
• #153
• Documentation
  • #154
• Chatops
  • Slack
  • MIcrosoft Teams
• Notification
  • #261
  • Slack
  • Microsoft Teams
  • #378
• Synchronization options
  • #54
  • #97
• #177
• #131

Unfortunately, mkdocs-deploy-gh-pages doesn't support mike now (#52).

We have to change the prefix/repos/:id into the GitHub-styled prefix like repos/:namespace/:name for more apparent APIs.
It can be a significant change, but I think we have to achieve it before being public.

• #135
• #137

Description

This feature enables Gitploy to deploy automatically if a new push event is matched with the giving ref pattern. For example, it can be handy if a team wants to deploy when a pull request is merged to the main branch.

Implement

To listen for push events, Gitploy has to add the push event when it creates a new webhook. At now, Gitploy only configures the deployment_status event when a user activates a repository. (code)

And another issue is to specify who is the deployer for auto-deployment. The user who activated the repository called activator could be the deployer for auto-deployment because the activator has admin permission to post a remote deployment and is usually equal to a reviewer.

Example

envs:
  - name: prod
    auto_deploy_on: refs/heads/main

Fix json tag of entity structure to use omitempty for the optional field, and use optional chaining in UI.

E.g)

type Repo struct {
	config `json:"-"`
	// ID of the ent.
	ID string `json:"id,omitempty"`
	// Namespace holds the value of the "namespace" field.
	Namespace string `json:"namespace,omitemtpy"`

interface Repo {
  id: string
  namespace?: string  // Optional field 
}

Version 0.2 supports lock/unlock the repository to block deploying, so Gitploy needs to support Slack commands for those who can access the web because of some situations.

If a deployment with the branch has waited for a while, it can reference the different SHA when it deploys to Github.

At this moment, I'll leave the warning in the document, and I will enhance it from use-cases.

Lock the repository to block deploying. This feature is useful when users try to rollback.

We should provide metrics about the Gitploy application that users can manage Gitploy themselves. In the issue, we'll consider 1) which metrics are being and 2) how to implement them.

Metrics

• The response code of the server
• The count of repositories
• The count of deployment of repository for each environment (e.g. dev, production), respectively
• The count of user
• The limit of user

#201 add the reviewers field to specify reviewers in deploy.yml.

• enhance the readability of notification.
• check it without redirection.

To handle the ' deleted ' event, the event has to specify the type, such as updated and deleted.

Provide the lock tab, and it shows the list of environments with the button for lock (or unlock).

API Design

Provide the following APIs:

• POST /repos/:id/locks: Lock the environment.
• GET /repos/:id/locks: List up locked environments.
• DELETE /repos/:id:/locks/:lockID: Delete the lock.

Change the interface of the response to support the delete event.

• #105
• #108

When the user runs the command /gitploy deploy, firstly, it shows the select for repositories. - It is impossible because Slack doesn't support the external source with search. Indeed, the command has to specify the repository name like/gitploy deploy OWNER/REPO.

Gitploy provides the feature that an admin user can delete a member for the license limit, which means an admin user can access all members and delete members.

Configures members with the environment GITPLOY_MEMBER_ENTRIES.

As is

When users deploy, they select reviewers who usually have committed to the release even though reviewers have already reviewed the pull request.

To be

The reviewer should be a maintainer or admin who can determine to deploy the release to the production.

Variables can be instrumental because the content of the deploy.yml is static. So we have to support some variables users needs.

Variables

• GITPLOY_DEFAULT_TASK
• GITPLOY_IS_ROLLBACK
• GITPLOY_TAG - For mono-repository, it could be useful with the substitution.

It distinguishes statistics tables from application tables.

Migrate type of errors, such as type from ent, into Error which is the Gitploy error type.

Related #189

Deployment needs the status for the inactive status. The worker should inactivate deployments that are over the time limit.

The inactive status doesn't have any special features; it just denotes the deployment is stale.

Github Abandoned

summary

Gitploy pushes deployments and approvals to the event queue that subscribers are watching. The stream subscribers put events to web pages to synchronize instantly, and the notification subscriber sends a notification to the user.

Implement

we need two tables, events and notifications, events is the event queue that is subscribed periodically, instead notifications is the record to avoid duplicated notifications.

• #16
• #19

Some fields of a payload can be optional fields. To handle the payload which has optional fields, in the server, the field of payload structure has to be a pointer type.

e.g) Update Repo

PatchRepoPayload struct {
  ConfigPath *string
  Active *bool
}

We should support fine-grained access control for API. I've referenced Github App permission policy.

To provide GitHub Enterprise, I have to check the GitHub Enterprise serves all APIs Gitploy calls. The below is APIs Gitploy calls (I've researched it based on v3.2.0):

• Org & User: List organizations
• Deployment
• Content
• Commit: Compare two commits
• Branch
• Check-Run: List check suites for a Git reference
• Webhook
• Tags (Graphql): RefConnections of GraphQL Object