Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cEP-0024.md: GitMate Plugins #142

Merged
merged 1 commit into from
Jul 30, 2018
Merged

cEP-0024.md: GitMate Plugins #142

merged 1 commit into from
Jul 30, 2018

Conversation

Vamshi99
Copy link
Member

Closes #141

cEP-0024.md Outdated
@@ -0,0 +1,84 @@
Implement GitMate automations and plugins for coala

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpmw__hwag/cEP-0024.md
+++ b/tmp/tmpmw__hwag/cEP-0024.md
@@ -1,17 +1,15 @@
-Implement GitMate automations and plugins for coala
-===================================================
+# Implement GitMate automations and plugins for coala
 
-|Metadata|                                                   |
-|--------|---------------------------------------------------|
-|cEP     |24                                                 |
-|Version |1.0                                                |
-|Title   |Implement Gitmate automations and plugins for coala|
-|Authors |Vamshi Krishna Bommerla <[email protected]>     |
-|Status  |Proposed                                           |
-|Type    |Process                                            |
+| Metadata |                                                       |
+| -------- | ----------------------------------------------------- |
+| cEP      | 24                                                    |
+| Version  | 1.0                                                   |
+| Title    | Implement Gitmate automations and plugins for coala   |
+| Authors  | Vamshi Krishna Bommerla <mailto:[email protected]> |
+| Status   | Proposed                                              |
+| Type     | Process                                               |
 
-Abstract
---------
+## Abstract
 
 This cEP describes the details of the process of creating new automations and
 plugins in GitMate which helps coala development workflow, as a part of the

cEP-0024.md Outdated
@@ -0,0 +1,84 @@
Implement GitMate automations and plugins for coala

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpmw__hwag/cEP-0024.md
+++ b/tmp/tmpmw__hwag/cEP-0024.md
@@ -1,17 +1,15 @@
-Implement GitMate automations and plugins for coala
-===================================================
+# Implement GitMate automations and plugins for coala
 
-|Metadata|                                                   |
-|--------|---------------------------------------------------|
-|cEP     |24                                                 |
-|Version |1.0                                                |
-|Title   |Implement Gitmate automations and plugins for coala|
-|Authors |Vamshi Krishna Bommerla <[email protected]>     |
-|Status  |Proposed                                           |
-|Type    |Process                                            |
+| Metadata |                                                       |
+| -------- | ----------------------------------------------------- |
+| cEP      | 24                                                    |
+| Version  | 1.0                                                   |
+| Title    | Implement Gitmate automations and plugins for coala   |
+| Authors  | Vamshi Krishna Bommerla <mailto:[email protected]> |
+| Status   | Proposed                                              |
+| Type     | Process                                               |
 
-Abstract
---------
+## Abstract
 
 This cEP describes the details of the process of creating new automations and
 plugins in GitMate which helps coala development workflow, as a part of the

cEP-0024.md Outdated
@@ -0,0 +1,82 @@
#Implement GitMate automations and plugins for coala
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space after #

cEP-0024.md Outdated
| Status | Proposed |
| Type | Process |

##Abstract
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above.

cEP-0024.md Outdated

### Auto-assign issue based on commit mention

When a commit mentions(fixes,closes) an issue, auto assign unassigned issues.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

space after ,

cEP-0024.md Outdated
### Auto-reject PR opened on master of forks

Normally, we should make changes in different branch from master of forks, and
submit a PR. But, sometimes we receive PR’s from master of forks. To solve this
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR's --> PRs ?

cEP-0024.md Outdated

Our members often confuse when we should use `Fixes` or `Closes` on a commit.
So, GitMate should automatically check every commit for issues which is being
Fixed or Closed, if those issues have bug label, fixes should be used, and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixes should be used --> Fixes should be used

cEP-0024.md Outdated

Our members often confuse when we should use `Fixes` or `Closes` on a commit.
So, GitMate should automatically check every commit for issues which is being
Fixed or Closed, if those issues have bug label, fixes should be used, and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issues have bug label --> issues have a label bug?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the list of labels be configuration?

If it is a specific label, what happens if the repo doesnt have that label? Will GitMate create the label? what color will it be?

cEP-0024.md Outdated

Sometimes, there will be members in the organisation, misusing the rights,
violating the code of conduct, disturbing our workflow. It will definitely take
some time to fix that security issue, bearing that user, until then will be a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

until then there will be a..?

cEP-0024.md Outdated

### Assign Plugin

Assign issue when a user comments on an issue requesting for an assignemnet
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

assignemnet --> assignment

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What will be the syntax for the user requesting assignment?

What will be the rules in place before the user is assigned.
We have lots of rules in corobo, including the not implemented 'GCI' problem where a specific subset of issues are reserved for a subset of users, and the org is expected to let only the student finish the task if they have claimed it in GCI.

cEP-0024.md Outdated

## Introduction

GitMate.io is an automation tool for developers. While it works well, there are
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

link to https://gitmate.io ?

cEP-0024.md Outdated

### Auto-assign issue based on commit mention

When a commit mentions(fixes,closes) an issue, auto assign unassigned issues.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will it provide a comment on the issue that coala can configure to suit our needs?

and what happens if they are not an org member, and cant be assigned?

a comment pinging maintainers?

a gitmate managed queue for maintainers to check?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing about this has been added.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jayvdb
Yes, a configurable comment on the issue when user is assigned.

If they are not in the org, they will be informed to get invited.

I am thinking of a directly assigning the user to the issue.

cEP-0024.md Outdated
Normally, we should make changes in different branch from master of forks, and
submit a PR. But, sometimes we receive PR’s from master of forks. To solve this
problem, we need a mechanism by which gitmate automatically rejects those PR’s,
and inform the PR author to work on a different branch.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and if they repeat the problem? ... ;-)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are informing them to work on different branch and open the PR, however if they are repeating the same, we can't do anything else.

cEP-0024.md Outdated

### Auto-mark PR with necessary labels as per the reviews done

When a reviewer reviews a PR and either he approves changes or request changes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'approves'/'requests changes' means ack/nack and/or GitHub review approvals/review changes requested & GitLab MR approvals / comments ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub review approvals/review changes requested & GitLab MR approvals / comments

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cEP-0024.md Outdated

Our members often confuse when we should use `Fixes` or `Closes` on a commit.
So, GitMate should automatically check every commit for issues which is being
Fixed or Closed, if those issues have bug label, fixes should be used, and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the list of labels be configuration?

If it is a specific label, what happens if the repo doesnt have that label? Will GitMate create the label? what color will it be?

cEP-0024.md Outdated
violating the code of conduct, disturbing our workflow. It will definitely take
some time to fix that security issue, bearing that user, until then will be a
lot of pain. So, a plugin to ban a user from using GitMate further and removing
his rights at that very moment will be helpful. Ban user plugin will be created
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how will the plugin work?

how do we ban the user?

in gitmate.io UI , or on GitHub/GitLab comments?

or we remove them from GitHub/GitHub org members, and GitMate respects the GitHub/GitHub org members?

cEP-0024.md Outdated

### Assign Plugin

Assign issue when a user comments on an issue requesting for an assignemnet
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What will be the syntax for the user requesting assignment?

What will be the rules in place before the user is assigned.
We have lots of rules in corobo, including the not implemented 'GCI' problem where a specific subset of issues are reserved for a subset of users, and the org is expected to let only the student finish the task if they have claimed it in GCI.

cEP-0024.md Outdated

Check for merge conflicts and give link to documentation on how to fix it.

## Mockups
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, the mockups are here. I think it is more useful to have them in the relevant sections.

cEP-0024.md Outdated
Assign issue when a user comments on an issue requesting for an `assignment`
to that issue. Will support settings for each team like limit team to work on
issues with specific set of labels, limit number of issues of specified label,
a team member can work on.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -66,7 +66,7 @@
 Assign issue when a user comments on an issue requesting for an `assignment`
 to that issue. Will support settings for each team like limit team to work on
 issues with specific set of labels, limit number of issues of specified label,
-a team member can work on. 
+a team member can work on.
 

Settings:

cEP-0024.md Outdated

> @gitmate-bot assign

@user, you have been assigned

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -81,8 +81,8 @@
 > @gitmate-bot assign
 
   @user, you have been assigned
+

Auto-review merge conflicts

Check for merge conflicts and give link to documentation on how to fix it.

cEP-0024.md Outdated

### Auto-review merge conflicts

Check for merge conflicts and give link to documentation on how to fix it.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -86,3 +86,4 @@
 ### Auto-review merge conflicts
 
 Check for merge conflicts and give link to documentation on how to fix it.
+```

cEP-0024.md Outdated
Assign issue when a user comments on an issue requesting for an `assignment`
to that issue. Will support settings for each team like limit team to work on
issues with specific set of labels, limit number of issues of specified label,
a team member can work on.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -66,7 +66,7 @@
 Assign issue when a user comments on an issue requesting for an `assignment`
 to that issue. Will support settings for each team like limit team to work on
 issues with specific set of labels, limit number of issues of specified label,
-a team member can work on. 
+a team member can work on.
 

Settings:

cEP-0024.md Outdated

> @gitmate-bot assign

@user, you have been assigned

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -81,8 +81,8 @@
 > @gitmate-bot assign
 
   @user, you have been assigned
+

Auto-review merge conflicts

Check for merge conflicts and give link to documentation on how to fix it.

cEP-0024.md Outdated

### Auto-review merge conflicts

Check for merge conflicts and give link to documentation on how to fix it.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -86,3 +86,4 @@
 ### Auto-review merge conflicts
 
 Check for merge conflicts and give link to documentation on how to fix it.
+```

cEP-0024.md Outdated
Assign issue when a user comments on an issue requesting for an `assignment`
to that issue. Will support settings for each team like limit team to work on
issues with specific set of labels, limit number of issues of specified label,
a team member can work on.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -66,7 +66,7 @@
 Assign issue when a user comments on an issue requesting for an `assignment`
 to that issue. Will support settings for each team like limit team to work on
 issues with specific set of labels, limit number of issues of specified label,
-a team member can work on. 
+a team member can work on.
 

Settings:

cEP-0024.md Outdated

> @gitmate-bot assign

@user, you have been assigned

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -81,8 +81,8 @@
 > @gitmate-bot assign
 
   @user, you have been assigned
+

Auto-review merge conflicts

Check for merge conflicts and give link to documentation on how to fix it.

cEP-0024.md Outdated

### Auto-review merge conflicts

Check for merge conflicts and give link to documentation on how to fix it.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text does not comply to the set style.

Origin: MarkdownBear, Section: markdown.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpzfajtu_d/cEP-0024.md
+++ b/tmp/tmpzfajtu_d/cEP-0024.md
@@ -86,3 +86,4 @@
 ### Auto-review merge conflicts
 
 Check for merge conflicts and give link to documentation on how to fix it.
+```

cEP-0024.md Outdated

### Auto-assign issue based on commit mention

When a commit mentions(fixes, closes) an issue, auto assign unassigned issues.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

autoassign who to which unassigned issues? This is fuzzy

cEP-0024.md Outdated

When a reviewer reviews a PR and either he approves changes or request changes
and leaves it there, but PR would be still in the review queue, so there should
be an automation to mark approve label if reviewer approves changes and mark
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not only approve label, also setting the wip label when people start unacking and/or commeting on the source code as well as on CI fail possibly?

cEP-0024.md Outdated
be a lot of pain. So, a plugin to ban a user from using GitMate further and
removing his rights at that very moment will be helpful. Ban user plugin,
which can be configured in gitmate UI will be created within this project.
Removing that user from the org will be configurable.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wait, GitMate isn't supposed to improve on the GitHub permission system. What's against just removing the user from the org thus disabling all rights to GitMate for features that check for authentication?

cEP-0024.md Outdated

### Auto-review merge conflicts

Check for merge conflicts and give link to documentation on how to fix it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you be more specific?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cEP-0024.md Outdated
> @gitmate-bot assign

@user, you have been assigned

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's this newline for?

cEP-0024.md Outdated
Assign issue when a user comments on an issue requesting for an `assignment`
to that issue. Will support settings for each team like limit team to work on
issues with specific set of labels, limit number of issues of specified label,
a team member can work on.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't corobo already do this? What's the problem with that? (The problem should be at least explained here if there is one.)

@Vamshi99
Copy link
Member Author

@jayvdb Done

cEP-0024.md Outdated
or when there is any CI failure.

GitMate will consider only maintainer reviews, to consider developer reviews,
GitMate has use teams, but using teams in GitMate is not a part of my project.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitMate has use teams -> GitMate and IGitt would need to add support for teams

my project -> this project

cEP-0024.md Outdated
needs a better mechanism to clear review queue when any maintainer reviews PR
or when there is any CI failure.

GitMate will consider only maintainer reviews, to consider developer reviews,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

full stop after "maintainer reviews". Then start a new sentence

cEP-0024.md Outdated
GitMate may consider using teams in the future.

When a PR is opened, updated or when any maintainer reviews the PR, GitMate
will automatically mark labels, as per the following conditions:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"automatically mark labels" isnt clear.

I guess "add labels" ... ?

Also should say that it will remove the "pending review" label, which still isnt mentioned anywhere in this section

### Notify Merge conflicts in a PR

When a PR is opened or updated, check for merge conflicts in it,
if there are any conflicts, mark the PR with a certain label (configurable) and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should also remove the "pending review" label?

cEP-0024.md Outdated
so that maintainers can identify these type of PRs and GitMate will comment
on the PR informing the author of the PR to get invited to the organization
before working on any issue. After the newcomer has accepted the invite,
he/she needs to re-push to remove the label added by GitMate.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmp3usw2_q1/cEP-0024.md
+++ b/tmp/tmp3usw2_q1/cEP-0024.md
@@ -86,7 +86,7 @@
 so that maintainers can identify these type of PRs and GitMate will comment
 on the PR informing the author of the PR to get invited to the organization
 before working on any issue. After the newcomer has accepted the invite,
-he/she needs to re-push to remove the label added by GitMate. 
+he/she needs to re-push to remove the label added by GitMate.
 
 coala can configure this plugin as:
 

cEP-0024.md Outdated
so that maintainers can identify these type of PRs and GitMate will comment
on the PR informing the author of the PR to get invited to the organization
before working on any issue. After the newcomer has accepted the invite,
he/she needs to re-push to remove the label added by GitMate.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

Origin: SpaceConsistencyBear, Section: spacing.

The issue can be fixed by applying the following patch:

--- a/tmp/tmpiwyz2038/cEP-0024.md
+++ b/tmp/tmpiwyz2038/cEP-0024.md
@@ -86,7 +86,7 @@
 so that maintainers can identify these type of PRs and GitMate will comment
 on the PR informing the author of the PR to get invited to the organization
 before working on any issue. After the newcomer has accepted the invite,
-he/she needs to re-push to remove the label added by GitMate. 
+he/she needs to re-push to remove the label added by GitMate.
 
 coala can configure this plugin as:
 

@jayvdb
Copy link
Member

jayvdb commented Jul 30, 2018

ack 42b9daa

@jayvdb
Copy link
Member

jayvdb commented Jul 30, 2018

@gitmate-bot rebase

@gitmate-bot
Copy link

Hey! I'm GitMate.io! This pull request is being rebased automatically. Please DO NOT push while rebase is in progress or your changes would be lost permanently ⚠️

@gitmate-bot
Copy link

Automated rebase with GitMate.io was successful! 🎉

@jayvdb
Copy link
Member

jayvdb commented Jul 30, 2018

reack a4b2ab3

@jayvdb
Copy link
Member

jayvdb commented Jul 30, 2018

ack a4b2ab3

@jayvdb
Copy link
Member

jayvdb commented Jul 30, 2018

@gitmate-bot ff

@gitmate-bot
Copy link

Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently ⚠️

@gitmate-bot gitmate-bot merged commit a4b2ab3 into coala:master Jul 30, 2018
@gitmate-bot
Copy link

Automated fastforward with GitMate.io was successful! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.