-
Notifications
You must be signed in to change notification settings - Fork 442
Home
Welcome to the PySceneDetect wiki! This wiki is used to coordinate development of the project. For documentation, visit https://www.scenedetect.com/docs/.
Features and bugs are addressed here on Github. Pull requests are encouraged.
Development for upcoming releases happens in the develop branch. When the next release is ready, develop should be merged back into main, and a new release branch created (e.g. releases/0.6.2) at the same point. From this branch, the documentation is generated and maintained, as well as any bugfixes. Once the release is ready, the exact commit of a particular release should be tagged (e.g. 0.6.2-release). Documentation for releases is built from their respective release branches, and the website is built from main.
Code needs to pass builds on Linux and Windows using different Python versions, and also must be linted according to the project's .style.yapf file.
Currently @Breakthrough is responsible for tagging, generating, and uploading each release. This includes the scenedetect package on PyPI, signed Windows .EXE builds, and the .MSI installer.
Documentation is generated from each release branch, and is hosted using Github Pages. Currently, documentation is generated with a Github Action workflow. This must be triggered manually currently, but can and may be automated in the future.
The website is generated from the main branch and is hosted using Github Pages. @Breakthrough owns and maintains the domain name scenedetect.com for the project. The website is updated automatically by Github Actions.