Skip to content

Commit 33795bf

Browse files
committed
Added documentation about the release process
1 parent 4a74692 commit 33795bf

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -682,6 +682,25 @@ async fn main() -> Result<()> {
682682

683683
This project is licensed under the [MIT License](LICENSE) - see the [LICENSE](LICENSE) file for details.
684684

685+
## Release Process
686+
687+
Releases are automated through GitHub Actions workflows. To create a new release:
688+
689+
1. Update the version in `Cargo.toml`
690+
2. Update the changelog in `CHANGELOG.md`
691+
3. Create and push a new tag:
692+
693+
```bash
694+
VERSION=$(grep '^version = ' Cargo.toml | cut -d'"' -f2)
695+
git tag v$VERSION && git push origin v$VERSION
696+
```
697+
698+
This will automatically trigger the release workflow which will:
699+
- Build the crate
700+
- Run tests
701+
- Create a GitHub release
702+
- Publish to crates.io
703+
685704
## Contributing
686705

687706
Contributions are welcome! Here's how you can contribute:
@@ -802,4 +821,3 @@ By following these steps, cargo-husky will enforce code quality standards on eve
802821
803822
- [Jonas Depoix](https://github.com/jdepoix) for the original [youtube-transcript-api](https://github.com/jdepoix/youtube-transcript-api) Python library
804823
- All contributors who have helped improve this library
805-

0 commit comments

Comments
 (0)