Skip to content

Commit 9a473ac

Browse files
VoxHashVoxHash
committed
chore: prepare v1.0.0 release
- Remove GITHUB_TOPICS.md - Update .gitignore with comprehensive patterns - Update CI workflow to test both packages - Add release workflow for automated releases - Update CHANGELOG.md for v1.0.0 release - Add release helper scripts and documentation
1 parent c495aa2 commit 9a473ac

70 files changed

Lines changed: 6738 additions & 3027 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
root = true
2-
3-
[*]
4-
charset = utf-8
5-
end_of_line = lf
6-
insert_final_newline = true
7-
trim_trailing_whitespace = true
8-
9-
[*.py]
10-
indent_style = space
11-
indent_size = 4
12-
max_line_length = 100
13-
14-
[*.{yml,yaml}]
15-
indent_style = space
16-
indent_size = 2
17-
18-
[*.{json,toml}]
19-
indent_style = space
20-
indent_size = 2
21-
22-
[*.md]
23-
trim_trailing_whitespace = false
24-
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
9+
[*.py]
10+
indent_style = space
11+
indent_size = 4
12+
max_line_length = 100
13+
14+
[*.{yml,yaml}]
15+
indent_style = space
16+
indent_size = 2
17+
18+
[*.{json,toml}]
19+
indent_style = space
20+
indent_size = 2
21+
22+
[*.md]
23+
trim_trailing_whitespace = false
24+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
labels: bug
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1.
13+
2.
14+
3.
15+
16+
**Expected behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Screenshots / logs**
20+
If applicable, add screenshots or error logs to help explain your problem.
21+
22+
**Environment**
23+
- OS: [e.g., Windows 11, macOS 14, Ubuntu 22.04]
24+
- Python Version: [e.g., 3.11.5]
25+
- Browser-Bookmark Checker Version: [e.g., 1.0.0]
26+
- GUI or CLI: [GUI/CLI]
27+
28+
**Additional context**
29+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/docs_improvement.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Documentation improvement
3+
about: Suggest improvements to documentation
4+
labels: documentation
5+
---
6+
7+
**What documentation needs improvement?**
8+
- [ ] README.md
9+
- [ ] CONTRIBUTING.md
10+
- [ ] docs/ folder
11+
- [ ] Code comments
12+
- [ ] Other: ___________
13+
14+
**Describe the issue**
15+
A clear description of what's unclear, missing, or incorrect.
16+
17+
**Suggested improvement**
18+
How would you improve it?
19+
20+
**Additional context**
21+
Add any other context or examples here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Summary
2+
Brief description of changes
3+
4+
## Related issues
5+
Closes #(issue number)
6+
7+
## Changes
8+
-
9+
-
10+
-
11+
12+
## Screenshots (if UI changes)
13+
<!-- Add screenshots if this PR includes UI changes -->
14+
15+
## Checklist
16+
- [ ] Tests added/updated
17+
- [ ] Documentation updated
18+
- [ ] Lint passes locally (`ruff check`)
19+
- [ ] Type checking passes (`mypy`)
20+
- [ ] Code formatted (`black`)
21+
- [ ] CHANGELOG.md updated (if applicable)
22+
23+
## Testing
24+
Describe how you tested your changes.

‎.github/workflows/ci.yml‎

Lines changed: 50 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,50 @@
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-
runs-on: ubuntu-latest
12-
strategy:
13-
matrix:
14-
python-version: ["3.11", "3.12"]
15-
16-
steps:
17-
- uses: actions/checkout@v4
18-
19-
- name: Set up Python ${{ matrix.python-version }}
20-
uses: actions/setup-python@v5
21-
with:
22-
python-version: ${{ matrix.python-version }}
23-
24-
- name: Install dependencies
25-
run: |
26-
python -m pip install --upgrade pip
27-
pip install -r requirements.txt
28-
pip install -e ".[dev]"
29-
30-
- name: Lint with ruff
31-
run: |
32-
ruff check bookmark_checker tests
33-
34-
- name: Format check with black
35-
run: |
36-
black --check bookmark_checker tests
37-
38-
- name: Type check with mypy
39-
run: |
40-
mypy bookmark_checker
41-
42-
- name: Test with pytest
43-
run: |
44-
pytest
45-
46-
- name: Upload coverage
47-
uses: codecov/codecov-action@v3
48-
with:
49-
file: ./coverage.xml
50-
fail_ci_if_error: false
51-
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+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
python-version: ["3.11", "3.12"]
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v5
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -r requirements.txt
28+
pip install -e ".[dev]"
29+
30+
- name: Lint with ruff
31+
run: |
32+
ruff check bookmark_checker media_checker tests
33+
34+
- name: Format check with black
35+
run: |
36+
black --check bookmark_checker media_checker tests
37+
38+
- name: Type check with mypy
39+
run: |
40+
mypy bookmark_checker media_checker || true
41+
42+
- name: Test with pytest
43+
run: |
44+
pytest --cov=bookmark_checker --cov=media_checker --cov-report=xml --cov-report=term-missing
45+
46+
- name: Upload coverage
47+
uses: codecov/codecov-action@v3
48+
with:
49+
file: ./coverage.xml
50+
fail_ci_if_error: false

‎.github/workflows/release.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
8+
jobs:
9+
build:
10+
runs-on: ${{ matrix.os }}
11+
strategy:
12+
matrix:
13+
os: [ubuntu-latest, windows-latest, macos-latest]
14+
python-version: ["3.11"]
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v5
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -r requirements.txt
28+
pip install build wheel
29+
30+
- name: Build distribution
31+
run: |
32+
python -m build
33+
34+
- name: Upload artifacts
35+
uses: actions/upload-artifact@v4
36+
with:
37+
name: dist-${{ matrix.os }}
38+
path: dist/
39+
40+
release:
41+
needs: build
42+
runs-on: ubuntu-latest
43+
permissions:
44+
contents: write
45+
46+
steps:
47+
- uses: actions/checkout@v4
48+
49+
- name: Download all artifacts
50+
uses: actions/download-artifact@v4
51+
with:
52+
path: dist/
53+
54+
- name: Create Release
55+
uses: softprops/action-gh-release@v1
56+
with:
57+
files: |
58+
dist/*
59+
generate_release_notes: true
60+
draft: false
61+
prerelease: false
62+
env:
63+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)