Skip to content

Commit 7ca0e51

Browse files
DannyFelizDannyFeliz
committed
Configure github actions
1 parent 64955ae commit 7ca0e51

7 files changed

Lines changed: 385 additions & 46 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main, develop ]
8+
9+
jobs:
10+
test:
11+
name: Test on Node.js ${{ matrix.node-version }} and ${{ matrix.os }}
12+
runs-on: ${{ matrix.os }}
13+
14+
strategy:
15+
matrix:
16+
node-version: [20.x, 22.x, latest]
17+
os: [ubuntu-latest, macos-latest, windows-latest]
18+
19+
steps:
20+
- name: Checkout code
21+
uses: actions/checkout@v4
22+
23+
- name: Setup Node.js ${{ matrix.node-version }}
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: ${{ matrix.node-version }}
27+
cache: 'npm'
28+
29+
- name: Install dependencies
30+
run: npm ci
31+
32+
- name: Run tests
33+
run: npm run test:run
34+
35+
- name: Run tests with coverage
36+
run: npm run test:coverage
37+
38+
- name: Upload coverage to Codecov
39+
if: matrix.node-version == '20.x' && matrix.os == 'ubuntu-latest'
40+
uses: codecov/codecov-action@v3
41+
with:
42+
file: ./coverage/lcov.info
43+
flags: unittests
44+
name: codecov-umbrella
45+
fail_ci_if_error: false
46+
47+
lint:
48+
name: Lint and Check
49+
runs-on: ubuntu-latest
50+
51+
steps:
52+
- name: Checkout code
53+
uses: actions/checkout@v4
54+
55+
- name: Setup Node.js
56+
uses: actions/setup-node@v4
57+
with:
58+
node-version: '20.x'
59+
cache: 'npm'
60+
61+
- name: Install dependencies
62+
run: npm ci
63+
64+
- name: Check CLI functionality
65+
run: |
66+
node create-pull-request.js --help
67+
echo "✅ CLI help command works"
68+
69+
- name: Verify package.json
70+
run: |
71+
npm pkg get name
72+
npm pkg get version
73+
echo "✅ Package.json is valid"

‎.gitignore‎

Lines changed: 38 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
# Created by https://www.toptal.com/developers/gitignore/api/node
2-
# Edit at https://www.toptal.com/developers/gitignore?templates=node
1+
# Dependencies
2+
node_modules/
3+
4+
# Coverage reports
5+
coverage/
6+
7+
# Test reports
8+
test-results/
39

4-
### Node ###
510
# Logs
611
logs
712
*.log
813
npm-debug.log*
914
yarn-debug.log*
1015
yarn-error.log*
11-
lerna-debug.log*
12-
13-
# Diagnostic reports (https://nodejs.org/api/report.html)
14-
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
16+
pnpm-debug.log*
1517

1618
# Runtime data
1719
pids
@@ -29,8 +31,7 @@ coverage
2931
# nyc test coverage
3032
.nyc_output
3133

32-
# Grunt intermediate storage
33-
# (https://gruntjs.com/creating-plugins#storing-task-files)
34+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
3435
.grunt
3536

3637
# Bower dependency directory (https://bower.io/)
@@ -43,7 +44,6 @@ bower_components
4344
build/Release
4445

4546
# Dependency directories
46-
node_modules/
4747
jspm_packages/
4848

4949
# TypeScript v1 declaration files
@@ -58,9 +58,6 @@ typings/
5858
# Optional eslint cache
5959
.eslintcache
6060

61-
# Optional stylelint cache
62-
.stylelintcache
63-
6461
# Microbundle cache
6562
.rpt2_cache/
6663
.rts2_cache_cjs/
@@ -79,7 +76,10 @@ typings/
7976
# dotenv environment variables file
8077
.env
8178
.env.test
82-
.env*.local
79+
.env.local
80+
.env.development.local
81+
.env.test.local
82+
.env.production.local
8383

8484
# parcel-bundler cache (https://parceljs.org/)
8585
.cache
@@ -94,8 +94,8 @@ dist
9494

9595
# Gatsby files
9696
.cache/
97-
# Comment in the public line in if your project uses Gatsby and not Next.js
98-
# https://nextjs.org/blog/next-9-1#public-directory-support
97+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
98+
# https://nextjs.org/docs/api-reference/next.config.js/introduction
9999
# public
100100

101101
# vuepress build output
@@ -116,4 +116,25 @@ dist
116116
# Stores VSCode versions used for testing VSCode extensions
117117
.vscode-test
118118

119-
# End of https://www.toptal.com/developers/gitignore/api/node
119+
# yarn v2
120+
.yarn/cache
121+
.yarn/unplugged
122+
.yarn/build-state.yml
123+
.yarn/install-state.gz
124+
.pnp.*
125+
126+
# IDE
127+
.vscode/
128+
.idea/
129+
*.swp
130+
*.swo
131+
*~
132+
133+
# OS
134+
.DS_Store
135+
.DS_Store?
136+
._*
137+
.Spotlight-V100
138+
.Trashes
139+
ehthumbs.db
140+
Thumbs.db

‎CONTRIBUTING.md‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
# Contributing to create-pull-request
2+
3+
Thank you for your interest in contributing to create-pull-request! This document provides guidelines and information about the development workflow.
4+
5+
## Development Setup
6+
7+
### Prerequisites
8+
9+
- Node.js >= 20
10+
- npm (comes with Node.js)
11+
12+
### Getting Started
13+
14+
1. **Fork the repository**
15+
```bash
16+
git clone https://github.com/yourusername/create-pull-request.git
17+
cd create-pull-request
18+
```
19+
20+
2. **Install dependencies**
21+
```bash
22+
npm install
23+
```
24+
25+
3. **Run tests**
26+
```bash
27+
npm test
28+
```
29+
30+
4. **Test the CLI**
31+
```bash
32+
node create-pull-request.js --help
33+
```
34+
35+
## Testing
36+
37+
We use [Vitest](https://vitest.dev/) for testing. The test suite includes:
38+
39+
- **Unit tests** for all core functions
40+
- **Integration tests** for complete workflows
41+
- **Edge case testing** for error handling
42+
- **Mocked dependencies** for isolated testing
43+
44+
### Running Tests
45+
46+
```bash
47+
# Run tests in watch mode (recommended during development)
48+
npm test
49+
50+
# Run tests once
51+
npm run test:run
52+
53+
# Run tests with coverage report
54+
npm run test:coverage
55+
56+
# Run tests in watch mode with coverage
57+
npm run test:watch
58+
```
59+
60+
### Coverage Thresholds
61+
62+
The project maintains the following coverage thresholds:
63+
64+
- **Statements**: 70%
65+
- **Branches**: 85%
66+
- **Functions**: 85%
67+
- **Lines**: 70%
68+
69+
## Continuous Integration (CI)
70+
71+
The project uses GitHub Actions for CI/CD. The workflow runs:
72+
73+
### Test Matrix
74+
75+
- **Node.js versions**: 20.x, 22.x, latest
76+
- **Operating systems**: Ubuntu, macOS, Windows
77+
- **Total combinations**: 9 different environments
78+
79+
### CI Jobs
80+
81+
1. **Test Job**
82+
- Runs all tests on the matrix combinations
83+
- Generates coverage reports
84+
- Uploads coverage to Codecov (Ubuntu + Node 20.x only)
85+
86+
2. **Lint Job**
87+
- Validates package.json
88+
- Tests CLI functionality
89+
- Performs basic sanity checks
90+
91+
### Workflow Triggers
92+
93+
The CI runs on:
94+
- Push to `main` and `develop` branches
95+
- Pull requests targeting `main` and `develop`
96+
97+
## Code Quality
98+
99+
### Coverage Requirements
100+
101+
All new code should maintain or improve test coverage. The CI will fail if coverage drops below the thresholds.
102+
103+
### Browser Support
104+
105+
When adding new browser support, ensure:
106+
107+
1. **Add browser to `SUPPORTED_BROWSERS`** in `create-pull-request.js`
108+
2. **Update tests** in `create-pull-request.test.js`
109+
3. **Update README** with new browser information
110+
4. **Test manually** that the browser opens correctly
111+
112+
### Platform Support
113+
114+
When adding new platform support:
115+
116+
1. **Add platform handler** to `SUPPORTED_PLATFORMS`
117+
2. **Add comprehensive tests** for URL generation
118+
3. **Update documentation** in README
119+
4. **Test with real repositories** from that platform
120+
121+
## Pull Request Process
122+
123+
1. **Create a feature branch**
124+
```bash
125+
git checkout -b feature/your-feature-name
126+
```
127+
128+
2. **Make your changes**
129+
- Write code following existing patterns
130+
- Add tests for new functionality
131+
- Update documentation as needed
132+
133+
3. **Test your changes**
134+
```bash
135+
npm run test:coverage
136+
```
137+
138+
4. **Commit your changes**
139+
```bash
140+
git commit -m "feat: add amazing new feature"
141+
```
142+
143+
5. **Push and create PR**
144+
```bash
145+
git push origin feature/your-feature-name
146+
```
147+
148+
6. **Wait for CI**
149+
- All tests must pass
150+
- Coverage must meet thresholds
151+
- CLI functionality must work
152+
153+
## Development Tips
154+
155+
### Testing Strategy
156+
157+
- **Test the happy path**: Ensure normal usage works
158+
- **Test edge cases**: Invalid inputs, network errors, etc.
159+
- **Test integration**: Complete workflows from start to finish
160+
- **Mock external dependencies**: Keep tests fast and reliable
161+
162+
### Debugging Tests
163+
164+
```bash
165+
# Run a specific test file
166+
npx vitest create-pull-request.test.js
167+
168+
# Run tests with specific pattern
169+
npx vitest --grep "normalizeGitUrl"
170+
171+
# Run tests with debug output
172+
npx vitest --reporter=verbose
173+
```
174+
175+
### Local Development
176+
177+
```bash
178+
# Link the package locally for testing
179+
npm link
180+
181+
# Now you can test the CLI globally
182+
create-pull-request --help
183+
184+
# Unlink when done
185+
npm unlink
186+
```
187+
188+
## Release Process
189+
190+
1. **Ensure all tests pass**
191+
2. **Update version** in `package.json`
192+
3. **Create release notes**
193+
4. **Tag the release**
194+
5. **Publish to npm**
195+
196+
## Getting Help
197+
198+
- **Issues**: [GitHub Issues](https://github.com/DannyFeliz/create-pull-request/issues)
199+
- **Discussions**: [GitHub Discussions](https://github.com/DannyFeliz/create-pull-request/discussions)
200+
201+
## Code of Conduct
202+
203+
Please be respectful and professional in all interactions. We want to maintain a welcoming environment for all contributors.
204+
205+
---
206+
207+
Thank you for contributing! 🎉

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 Danny Feliz
3+
Copyright (c) 2025 Danny Feliz
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)