tianhaoz95 / approveman

A GitHub App that automatically approve specified changes.

About me 👋

• I’m currently working on 💻
  • Flutter Version: Fastlane plugin to retrieve Flutter version information.
  • ApproveMan (discontinued): A GitHub app to help approve PR that only modify things in safe locations.
  • Check Goup (discontinued): A GitHub app to group checks into one check based on subprojects.
• Ask me about 💬
  • Mobile app development (Flutter) 📱
  • Reinforcement learning 🤖
• Fun fact ⚡
  • A boba a day keeps bugs away.

Quick references 📚

Organizations 🏅

Utilities 🧰

• Pylon 💎 💎 💎 : environment for my personal Windows dev machines.
• WOW Profile: my personal wow link mapping.

approveman's Issues

Finish privacy notice

Yet another breaking change :(

Yet another breaking change :(

Originally posted by @tianhaoz95 in #131 (comment)

Final pass of refactoring before releasing the app

Add contributor: epDHowwD

@all-contributors please add epDHowwD for bug

Explore if GHE app actor name can be supported with get app API

You may try to use the authenticated app endpoint. It returns the configured name, id, avatar, and even the html_url and external_url, which might be interesting for status posts.
I don't now much about probot app development, so it is just a guess. As we are building the app from source, a central modifiable variable would already do the trick. Also ENV during build-time or runtime would work. As you asked for examples for our naming schemes, we prefix the apps usually with an organization name separated with -. However, I do not recommend to stick to this in your app.

Referenced from the original issue #64

See what permissions are needed

Specifically, is the write access to content really necessary for it to pass the protected branch check.

[FEAT] Add a switch to control if .github directory is allowed

[FEAT] Until the sunset of the docker registry, probably should still update what's there

[FEAT] Add a way to retry with comment

Investigate how much work that will be.

Use a logger in unit tests

Sometimes Probot context is not accessible, but we still want to log some useful information in tests, consider using https://tslog.js.org/#/README.

[FEAT] Add capabilities to blacklist or whitelist usernames

Is your feature request related to a problem? Please describe.
In case some users are checking in shady stuff, there should be a way to control who is allowed to check in stuff at all.

Describe alternatives you've considered
Can't think of any.

Should also post a status complete here

approveman/src/core/index.ts

Line 232 in af8ec1c

await dismissAllApprovals(context);

This is what is causing the app to freeze if no approval is granted.

[FEAT] Update docs for the allow .github feature

Finish the Medium post on ApproveMan

Add contributor: <mohan>

@all-contributors please add <mohan> for <contributions>

Hi team, thanks for this information.
I do have a similar task in my repository we have (qa,uat, and staging). I'm trying to automate the code approval to automate to uat and staging.
Example: I have opened the feature branch pull request and got the reviews and merge code. So the same feature branch pull request is opened to merge code uat and stage, I need to add a status check to tell that the same feature branch has got approval in qa so no need for additional reviews in uat so automatically approves the review in uat and staging.

Can you please tell me how to do this we are not using "GitHub actions" but need to achieve without actions?

Pease can you give me a path forward.

[BUG] Whoops! An unknown error occured.

Describe the bug
We have approveman running on our repo. Sometimes it would report "Whoops! An unknown error occured." while checking a PR. We've been using it for the last 2 business days and it happened twice.

To Reproduce
The bug is not easily reproducible.

Expected behavior
Approveman should be able to check a PR and approve (or ignore) without failing and reporting an error.

Screenshots
Crash 1:

Crash 2:

Additional context
Add any other context about the problem here.

Add a way to validate configuration

Could be a CLI?

approveman does not support deviating appname

I built and installed this app on a GitHub enterprise server and prefixed the app name with our project name (as gh enterprise does not scope apps). So then the name of the app (and hence the reviewing "user") was not approveman[bot] as hard coded in the code. Thus, the app was not able to dismiss its own review.

[FEAT] Good to accept comment commands

Is your feature request related to a problem? Please describe.
It would be good to give user a way to interact with the app instead always have it passively listening. For example, if it is for some reason not re-checking the status after an update (maybe the server load peaked), users can post a checking command to prompt it to do its job.

Describe the solution you'd like
Add an infra to listen to comments.

Describe alternatives you've considered
A site to add commands or a CLI. I would say CLI might be a good idea by itself, but site it too much work TBH.

Additional context
None

[BUG] Fix CI breakage

UPDATE

This is cacused by a recent change in Dependabot. For details, see https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions/.

Status not complete

Seems that the status only post a complete check mark if there is a rule match. Check if that is the case.

[FEAT] Add more stuff into the docs

• A place for discussion. Gitalk might be good.
• Dup community documentations into the docs for easier access.

Add contributor: tianhaoz95

@all-contributors please add tianhaoz95 for code, bug, blog, doc, design

Fix the Octokit type importing from probot

Fix the Octokit type importing from probot. It seems that they refactored the exporting in this version. Should probably import from octokit itself.

Originally posted by @tianhaoz95 in #50 (comment)

Complete community stuff

Make the repository ready for the contributor on the first day.

[BUG] ApproveMan not selectable as reviewer

Describe the bug
We've got a private repo (github.com/CamusEnergy/bando), for which we're trying to set up ApproveMan. I'm doing testing on my private fork with the same configuration (github.com/EnergySRE/bando), and seeing the same behavior in both places.

To Reproduce
Steps to reproduce the behavior:

1. Install ApproveMan with org-level permissions from GitHub Marketplace
2. Set "Repository access" to "All repositories"
3. Create a branch with the config below*
4. ApproveMan appears in the automated checks on the PR (screen shot below)
5. ApproveMan does not appear as an option on the reviewer list

I also tried adding ApproveMan as an authorized user to our organization, and receive a "no such user" error.

Expected behavior
I expect to be able to select ApproveMan as a reviewer and have it approve my PR based on the content of my config.

Screenshots

Automated checks pass:

ApproveMan not selectable as reviewer:

Additional context

Here's the config we're using:

ownership_rules:
  directory_matching_rules:
    - name: Markdown-only changes
      path: **/*.md
    - name: Doc folder
      path: doc/*

Finish the marketplace listing

[BUG] HTTPError: Not Found

Describe the bug
When creating a PR, the Approveman check failed (not neutral, but failed) with the following error:

HttpError: Not Found
at /app/node_modules/@octokit/request/dist-node/index.js:86:21
at runMicrotasks (<anonymous>)
at processTicksAndRejections (node:internal/process/task_queues:96:5)
at async sendRequestWithRetries (/app/node_modules/@octokit/auth-app/dist-node/index.js:454:12)
at async Job.doExecute (/app/node_modules/bottleneck/light.js:405:18)

To Reproduce
Steps to reproduce the behavior:

1. Add Approveman to your repo.
2. Configure it with limited scope for auto-approved changes (this happened with an allow-listed user, but it isn't clear if that is related).
3. Create a PR (with an allowed user) containing changes outside of the defined scope.
4. See error.

Expected behavior
The Approveman check should not succeed, but should complete with a neutral status.

Screenshots

[FEAT] Implement CLI

References

https://github.com/tj/commander.js/
https://github.com/klaussinani/signale
https://github.com/visionmedia/node-progress
https://github.com/chalk/chalk

[FEAT] initialize a CLI infra

Is your feature request related to a problem? Please describe.
There are things about the config that users want to check before submitting anything into the repository. For example, if the configuration file is valid at all or what will it do to a certain pull request.

Describe the solution you'd like
Initialize a CLI infra that shares code with the app.

Describe alternatives you've considered
Not much

Additional context
N/A

Set up docs directory

Add checking when a pull request contains ApproveMan config

It can probably add a comment to indicate if the config is valid.

[BUG] Config doesn't have syntax highlighting in docsify

[FEAT] maybe add a docker image to make GitHub Enterprise usage easier

Is your feature request related to a problem? Please describe.
Now users need to fork the repo and do a bunch of operations to get it running on GitHub Enterprise.

Describe the solution you'd like
Run a docker command and done.

Describe alternatives you've considered
There are many alternatives but none seems as effortless.

Additional context
Add any other context or screenshots about the feature request here.

Approveman seem to not recognize nested files

Approveman seem to not recognize nested files

Originally posted by @tianhaoz95 in tianhaoz95/mangekyo#5 (comment)

Release the app to probot

[FEAT] Maybe allow some files in .github with permissions set by the user

Finish the post for gitconnected

It should focus more on building customized github apps.

Release the app to marketplace

Set up CI to run tests for pull requests

Change default to playground instead of experimental

[BUG] Heroku automatic deployment is not working

Salesforce is investigating a security issue and disabled the feature: https://status.heroku.com/incidents/2413

Add documentation for available macros like username

As we add more and more macros, there needs to be a dedicated area for its documentation.

Finish GitHub Sponsor account setup

Set up personal directory in docs to take advantage of Approveman

Make the repository itself an example.

Add documentation for enterprise usage

It was recently brought to my attention that enterprise GitHub is drastically different from the GitHub in terms of apps, so a dedicated documentation for enterprise server usage can be helpful.

[FEAT] migrate heroku stack from 18 to 22

Add optional config to customize approving messages

It would be a good indicator for the new contributors to see useful information about how ApproveMan is doing right from the pull request comments.

A quick draft design:

ownership_rules:
  message:
    success: |
      "Thanks {{username}} for opening the request!"
  directory_matching_rules:
    - name: personal projects in experimental
      path: playground/{{username}}/**/*
    - name: personal documentation
      path: docs/personal/{{username}}/**/*
      message:
      success: |
        "Thanks {{username}} for opening the request!"

The message can be global or fine grained to be project specific.

We can make it into 2 steps where the first one is global only and the second one is supporting project specific message.

Disapprove anything that modifies .github directory

Better GitHub Enterprise experience

This is an umbrella bug for improvements for the GitHub Enterprise experience.

• Automate app actor name detection to some degree.