Add release workflow to github, pypi, and docker hub

[grqz]

Closes #2

Examples (released by 81becb3):

• Github release (plugin): definitely-not-bgutil-ytdlp-pot-provider-to-distinguish-from-it 0.2.29
• PyPI release (plugin): definitely-not-bgutil-ytdlp-pot-provider-to-distinguish-from-it 0.2.29
• Docker release (server): grqz/bgutil-ytdlp-pot-provider

Known limitations:

• Can't automatically modify the PyPI project description
• Doesn't delete the tag before overwriting releases(apply https://stackoverflow.com/questions/5480258/how-can-i-delete-a-remote-tag to fix it if necessary)

Features:

• Creates Releases
• Also aims to replace build.yml
• Don't push to Docker Hub when run from pull_request trigger. To push the image, trigger the workflow manually with workflow_dispatch
• Can overwrite PyPI, Docker Hub, Github releases

PR todos:

• Fix Docker tags/labels, determine whether the Docker meta step is necessary. Probably generate with shell instead.
• Add changelog for Github Release
• Add "Overview" for Docker Hub Release. See if possible to get it automated
• Fix Docker tags for prs
• Allow overwriting binaries for github releases
• Allow overwriting binaries for PyPI releases

to deploy this workflow file to this repo:

• Change project.name back to normal in plugin/pyproject.toml (needs changes in the repo)
• Change project.version to the normal one in plugin/pyproject.toml (needs changes in the repo)
• Follow Publishing package distribution releases using GitHub Actions CI/CD workflows to create a pending publisher under a PyPI account
• Set repo secret (follow Creating secrets for a repository) DOCKERHUB_USERNAME(docker hub username) and DOCKERHUB_TOKEN(docker hub password)

to make a new release:

1. Increment project.version in plugin/pyproject.toml
2. Trigger the workflow in the actions page

Code References:

• https://github.com/coletdjnz/yt-dlp-get-pot/blob/master/.github/workflows/release.yml
• https://github.com/docker/build-push-action/blob/v5/README.md
• https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-docker-images
• https://github.com/docker/metadata-action/blob/master/README.md
• https://stackoverflow.com/a/5261470
• https://github.com/coletdjnz/yt-dlp-get-pot/blob/master/pyproject.toml
• https://stackoverflow.com/questions/64781462/github-actions-default-branch-variable

[Brainicism]

Thanks for the awesome work! Just a few comments

[Brainicism]

Not sure if we want to do it in this PR or after the first pypi release, but we should include the pip install instructions on the README

[grqz]

Not sure if we want to do it in this PR or after the first pypi release, but we should include the pip install instructions on the README

probably do a follow-up pr after a pypi release is made
EDIT: #12

[Brainicism]

I've set the required repo secrets for dockerhub personal access token

[Brainicism]

Created trusted publisher on pypi

[grqz]

Included pr workflow
see https://github.com/grqz/bgutil-ytdlp-pot-provider/actions/runs/10661782621/job/29547857638?pr=10

[grqz]

• Change project.name back to normal in plugin/pyproject.toml (needs changes in the repo)
• Change project.version to the normal one in plugin/pyproject.toml (needs changes in the repo)

done in 62aa290

[Brainicism]

Good to merge at your discretion

[grqz]

Good to merge at your discretion

all things on the TODO list have been done, you can merge it now