Skip to content

added auto reply #206

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

Merged
merged 3 commits into from
Jul 23, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/auto-assign-reply.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Auto Reply to Assign Requests

on:
issue_comment:
types: [created]

jobs:
auto-reply:
runs-on: ubuntu-latest
env:
ASSIGN_KEYWORDS: |
assign this to me
please assign
assign me
can you assign
assign to me
can i be assigned
may i be assigned
could you assign
ASSIGN_RESPONSE: |
Please go ahead and create a PR when you are ready. We do not formally assign issues. Contributors are free to pick up any open issue based on their availability. You can open a PR or even a draft PR to let others know that you’re working on it.
steps:
- name: Check for assign request and comment
uses: actions/github-script@v7
with:
script: |
// Get keywords from env, split by newlines, and trim
const assignKeywords = process.env.ASSIGN_KEYWORDS.split('\n').map(k => k.trim()).filter(Boolean);
// Create regex patterns for each keyword (case-insensitive)
const assignPatterns = assignKeywords.map(k => new RegExp(k, 'i'));
const commentBody = context.payload.comment.body;
if (assignPatterns.some(pattern => pattern.test(commentBody))) {
const commenter = context.payload.comment.user.login;
const response = `@${commenter} ${process.env.ASSIGN_RESPONSE}`;
github.rest.issues.createComment({
issue_number: context.payload.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: response
});
}
58 changes: 21 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,21 @@
- Rich text formatting with clickable links
- Copy report to clipboard with proper formatting

2. **Advanced Repository Filtering**
* Select specific repositories to include in your report for a more focused summary.
* Easily search and manage your repository list directly within the popup.
* *Requires a GitHub token to fetch your repositories.*

3. **Include Commits on Existing PRs**
* Option to include recent commits made to pull requests that were opened *before* the selected date range.
* Provides a more detailed and accurate view of your work on long-running PRs.
* *Requires a GitHub token.*

### Usage Standalone
- Click on `GENERATE` button to generate the scrum preview.
- Edit it in the window.
- Copy the rich HTML using the `COPY` button.

## Setting up the code locally

```
$ git clone https://github.com/fossasia/scrum_helper/
$ cd scrum_helper
$ npm install
```

## Screenshots

Expand All @@ -86,41 +89,25 @@ $ npm install

![SETTINGSMENU](docs/images/settings.png)

## Using Scrum Helper with Your Own GitHub Organization

Scrum Helper is not limited to the [FOSSASIA](https://github.com/fossasia) organization. You can easily configure it to fetch and generate SCRUM reports for your own GitHub organization or repositories.
## Setting up the code locally

### Steps to Set It Up for Your Organization
```
$ git clone https://github.com/fossasia/scrum_helper/
$ cd scrum_helper
$ npm install
```

1. **Install the Extension**

* For Chrome: Load it into your browser through [Chrome Extension Developer Mode](https://developer.chrome.com/docs/extensions/mv3/getstarted/).
* For Firefox: Load it as a temporary add-on through `about:debugging` as described above.

2. **Update the Organization**
* Currently, the extension uses `org:fossasia` to fetch GitHub issues and PRs.
* To make it work with your GitHub organization:
* Open `scrumHelper.js` (or wherever the GitHub API URLs are defined).
* Replace:

```js
+org:fossasia+
```

with:

```js
+org:your-org-name+
```
<!-- * For Firefox: Load it as a temporary add-on through `about:debugging` as described above. -->

**Example**
![Code Snippet ](<Screenshot 2025-05-30 205822.png>)

3. **Build the Extension**
* Save your changes.
2. **Build the Extension**
* For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
* For Firefox: Reload the temporary add-on by going to `about:debugging` → "This Firefox" → Click "Reload" next to your extension.
4. **How to Obtain a GitHub Personal Access Token**
<!-- * For Firefox: Reload the temporary add-on by going to `about:debugging` → "This Firefox" → Click "Reload" next to your extension. -->

3. **How to Obtain a GitHub Personal Access Token**

- To use Scrum Helper with authenticated requests (for higher rate limits and private repositories), you need a GitHub personal access token.

Expand Down Expand Up @@ -150,9 +137,6 @@ Scrum Helper is not limited to the [FOSSASIA](https://github.com/fossasia) organ
**Why use a token?**
GitHub tokens allow the extension to make authenticated requests, increasing your API rate limit and enabling access to private repositories if you grant those permissions.

---
5. **Get Customized SCRUM Reports**
- The reports will now be generated using contributions from your organization.

## About contributing

Expand Down
Binary file removed Screenshot 2025-05-30 205822.png
Binary file not shown.
Binary file removed docs/images/old_icon.png
Binary file not shown.
Binary file modified docs/images/popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/popup2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/scrum.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/standalone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.