Skip to content

Commit 90a9db4

Browse files
committed
chore: setup github actions release workflow and update readme
1 parent 5aea30f commit 90a9db4

4 files changed

Lines changed: 66 additions & 7 deletions

File tree

.github/workflows/release.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Build and Release Extension
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*' # Trigger on version tags, e.g., v1.0.0
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write # Needed for creating a release
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
18+
- name: Setup Node.js
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: '20'
22+
cache: 'npm'
23+
24+
- name: Install dependencies
25+
run: npm ci
26+
27+
- name: Build extension
28+
run: npm run build
29+
30+
- name: Package extension (Zip)
31+
run: |
32+
cd dist
33+
zip -r ../commitcode-extension.zip *
34+
cd ..
35+
36+
- name: Create GitHub Release
37+
uses: softprops/action-gh-release@v2
38+
with:
39+
files: commitcode-extension.zip
40+
generate_release_notes: true
41+
draft: false
42+
prerelease: false

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,22 @@
2020

2121
---
2222

23-
## 🚀 Installation (Developer Mode)
23+
## 🚀 Installation
2424

25-
Since CommitCode is currently in active development, you can load it directly into Chrome using Developer Mode.
25+
### Option 1: Easy Installation (Recommended)
26+
You do not need to build the extension yourself. You can download the latest pre-built version directly from our releases!
27+
28+
1. Go to the [Releases](https://github.com/jaiswalism/commitcode/releases) page of this repository.
29+
2. Download the `commitcode-extension.zip` file from the latest release.
30+
3. Extract the `.zip` file on your computer.
31+
4. Open Google Chrome and navigate to `chrome://extensions/`.
32+
5. Enable **Developer mode** (toggle switch in the top right corner).
33+
6. Click **Load unpacked** in the top left corner.
34+
7. Select the extracted folder!
35+
36+
### Option 2: Build from Source (Developer Mode)
37+
38+
Since CommitCode is currently in active development, you can also build it directly from source.
2639

2740
1. **Clone or Download this repository** to your local machine:
2841
```bash

manifest.json

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"manifest_version": 3,
33
"name": "CommitCode",
4-
"version": "1.0.0",
4+
"version": "1.1.0",
55
"description": "Privacy-first browser extension that automatically syncs accepted coding problem submissions from LeetCode to GitHub.",
66
"icons": {
77
"16": "logo.png",
@@ -18,8 +18,12 @@
1818
},
1919
"content_scripts": [
2020
{
21-
"matches": ["https://leetcode.com/problems/*"],
22-
"js": ["src/content/index.ts"]
21+
"matches": [
22+
"https://leetcode.com/problems/*"
23+
],
24+
"js": [
25+
"src/content/index.ts"
26+
]
2327
}
2428
],
2529
"background": {
@@ -38,4 +42,4 @@
3842
"page": "src/options/index.html",
3943
"open_in_tab": true
4044
}
41-
}
45+
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "commitcode",
3-
"version": "1.0.0",
3+
"version": "1.1.0",
44
"description": "Privacy-first LeetCode to GitHub sync extension",
55
"type": "module",
66
"scripts": {

0 commit comments

Comments
 (0)