Skip to content

Commit fc57651

Browse files
authored
Merge pull request #128 from Preeti9764/gitlab
Added support for Gitlab
2 parents 9da123c + 33030cb commit fc57651

25 files changed

+3918
-1195
lines changed

.github/labeler.yml

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,51 @@
11
# Frontend changes
22
frontend:
3-
- 'src/**/*.html'
4-
- 'src/**/*.css'
3+
- "src/**/*.html"
4+
- "src/**/*.css"
55

6-
# JavaScript changes
6+
# JavaScript changes
77
javascript:
8-
- 'src/scripts/**/*.js'
9-
- 'src/**/*.js'
8+
- "src/scripts/**/*.js"
9+
- "src/**/*.js"
1010

1111
# Core functionality
1212
core:
13-
- 'src/scripts/scrumHelper.js'
14-
- 'src/scripts/emailClientAdapter.js'
13+
- "src/scripts/scrumHelper.js"
14+
- "src/scripts/emailClientAdapter.js"
1515

1616
# Documentation
1717
documentation:
18-
- '**/*.md'
19-
- 'docs/**'
20-
- 'LICENSE'
21-
- 'README.md'
18+
- "**/*.md"
19+
- "docs/**"
20+
- "LICENSE"
21+
- "README.md"
2222

2323
# Configuration files
2424
config:
25-
- '.github/**/*'
26-
- '*.json'
27-
- '*.yml'
28-
- '*.yaml'
29-
- 'package.json'
30-
- 'package-lock.json'
25+
- ".github/**/*"
26+
- "*.json"
27+
- "*.yml"
28+
- "*.yaml"
29+
- "package.json"
30+
- "package-lock.json"
3131

3232
# Browser extension specific
3333
extension:
34-
- 'manifest.json'
35-
- 'src/popup.html'
36-
- 'src/scripts/main.js'
34+
- "manifest.json"
35+
- "src/popup.html"
36+
- "src/scripts/main.js"
3737

3838
# Testing
3939
testing:
40-
- 'tests/**'
41-
- '**/*.test.js'
42-
- '**/*.spec.js'
40+
- "tests/**"
41+
- "**/*.test.js"
42+
- "**/*.spec.js"
4343

4444
# Dependencies
4545
dependencies:
46-
- 'package.json'
47-
- 'package-lock.json'
48-
- 'yarn.lock'
46+
- "package.json"
47+
- "package-lock.json"
48+
- "yarn.lock"
4949

5050
# Additional labels (manually applied, no patterns)
5151
bug: []

.github/workflows/sync-upstream.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ name: Sync Forks with Upstream
33
on:
44
schedule:
55
# Run daily at 2:00 AM UTC
6+
67
- cron: '0 2 * * *'
8+
79
workflow_dispatch:
810
# Allow manual triggering
911

@@ -12,14 +14,17 @@ jobs:
1214
runs-on: ubuntu-latest
1315
permissions:
1416
contents: write
17+
1518

19+
1620
steps:
1721
- name: Sync forks with upstream
1822
uses: actions/github-script@v7
1923
with:
2024
github-token: ${{ secrets.GITHUB_TOKEN }}
2125
script: |
2226
const { Octokit } = require('@octokit/rest');
27+
2328
2429
const octokit = new Octokit({
2530
auth: process.env.GITHUB_TOKEN
@@ -31,7 +36,7 @@ jobs:
3136
let syncedCount = 0;
3237
let skippedCount = 0;
3338
let errorCount = 0;
34-
39+
3540
try {
3641
// Get all forks
3742
console.log(`Getting forks of ${UPSTREAM_OWNER}/${UPSTREAM_REPO}...`);
@@ -93,4 +98,6 @@ jobs:
9398
} catch (error) {
9499
console.error('Workflow failed:', error.message);
95100
throw error;
96-
}
101+
102+
}
103+

README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Scrum Helper
32

43
**Scrum Helper** is a Chrome extension that simplifies writing development reports by auto-filling content based on your Git activity. Just enter your GitHub username, select a date range, and choose your preferences, the extension automatically fetches your commits, pull requests, issues, and code reviews via the GitHub API and generates a pre-filled report that you can edit as needed. While currently focused on Git-based workflows, Scrum Helper is designed to expand to other platforms in the future.
@@ -72,6 +71,7 @@
7271
* *Requires a GitHub token.*
7372

7473
### Usage Standalone
74+
7575
- Click on `GENERATE` button to generate the scrum preview.
7676
- Edit it in the window.
7777
- Copy the rich HTML using the `COPY` button.
@@ -99,45 +99,54 @@ $ npm install
9999

100100
1. **Install the Extension**
101101

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

105106

107+
108+
106109
2. **Build the Extension**
107110
* For Chrome: Rebuild or reload the extension in your browser (`chrome://extensions` → Refresh your extension).
108111
<!-- * For Firefox: Reload the temporary add-on by going to `about:debugging` → "This Firefox" → Click "Reload" next to your extension. -->
109112

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

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

114118
#### Steps to Generate a Token
115119

116120
1. **Go to GitHub Developer Settings:**
117-
Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account.
121+
Visit [https://github.com/settings/tokens](https://github.com/settings/tokens) while logged in to your GitHub account.
118122

119-
2. **Choose Token Type:**
120-
- Select **"Personal access tokens (classic)"**.
123+
2. **Choose Token Type:**
121124

122-
3. **Generate a New Token:**
123-
- Click **"Generate new token"**.
124-
- Give your token a descriptive name (e.g., "Scrum Helper Extension").
125-
- Set an expiration date if desired.
125+
- Select **"Personal access tokens (classic)"**.
126126

127-
4. **Create and Copy the Token:**
128-
- Click **"Generate token"** at the bottom.
129-
- **Copy the token** and save it securely. You will not be able to see it again!
127+
3. **Generate a New Token:**
130128

131-
5. **Paste the Token in Scrum Helper:**
132-
- Open the Scrum Helper extension popup.
133-
- Paste your token into the "GitHub Token" field.
129+
- Click **"Generate new token"**.
130+
- Give your token a descriptive name (e.g., "Scrum Helper Extension").
131+
- Set an expiration date if desired.
132+
133+
4. **Create and Copy the Token:**
134+
135+
- Click **"Generate token"** at the bottom.
136+
- **Copy the token** and save it securely. You will not be able to see it again!
137+
138+
5. **Paste the Token in Scrum Helper:**
139+
140+
- Open the Scrum Helper extension popup.
141+
- Paste your token into the "GitHub Token" field.
134142

135143
> **Keep your token secret!** Never share it or commit it to public repositories.
136144
137145
**Why use a token?**
138146
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.
139147

140148

149+
141150
## Adding a New Language
142151

143152
You can add a new language to Scrum Helper for your own use, or contribute it to the project.
@@ -168,6 +177,7 @@ If you want to share your translation with others:
168177

169178
For more details, see the [Chrome i18n documentation](https://developer.chrome.com/docs/extensions/reference/i18n/).
170179

180+
171181
## About contributing
172182

173183
- Follow the Issues and PRs templates as far as possible.

docs/images/icon128x128.svg

Lines changed: 65 additions & 65 deletions
Loading

0 commit comments

Comments
 (0)