Skip to content

Commit 9e331b1

Browse files
committed
Refactor contributing guidelines, remove Docker support, and update documentation
- Updated CONTRIBUTING.md to streamline contribution process and added new section for releasing a new version. - Removed Dockerfile and docker-compose.yml as part of the project restructuring. - Enhanced README.md and index.md for clarity and improved installation instructions. - Updated FFMPEG installation documentation across multiple files. - Added example Jupyter notebook for demonstrating usage. - Adjusted pyproject.toml for script naming and testing configurations. - Introduced new test_import.py to verify module import functionality. - Updated versioning in version.py to include a 'v' prefix.
1 parent d2dd10a commit 9e331b1

18 files changed

Lines changed: 1028 additions & 241 deletions

.changelog-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ group_by:
6060
- metadata.category
6161

6262
# Only tags matching this regular expression are used for the changelog.
63-
tag_pattern: ^[0-9]+\.[0-9]+(?:\.[0-9]+)?$
63+
tag_pattern: ^v?[0-9]+\.[0-9]+(?:\.[0-9]+)?$
6464

6565
# Tells `git-log` whether to include merge commits in the log.
6666
include_merges: false

.dockerignore

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Update Changelog
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*.*.*"
7+
8+
jobs:
9+
changelog:
10+
name: Update Changelog
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout Repo
14+
uses: actions/checkout@v6
15+
with:
16+
fetch-depth: 0
17+
18+
- name: Generate changelog
19+
id: changelog
20+
uses: callowayproject/generate-changelog@v0
21+
with:
22+
config_file: .changelog-config.yaml
23+
24+
- name: Commit changelog
25+
run: |
26+
git config user.name "github-actions[bot]"
27+
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
28+
git add CHANGELOG.md
29+
git commit -m "chore: update CHANGELOG for ${{ github.ref_name }}" || echo "No changes"
30+
git push

.github/workflows/release.yml

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)