From 71b739b53aa6adc93018985e789e80a3df5da0b6 Mon Sep 17 00:00:00 2001
From: 12f23eddde <12f23eddde@gmail.com>
Date: Thu, 27 Jun 2024 16:55:34 +0800
Subject: [PATCH] docs: add release pipeline to contributing.md

---
 docs/contributing.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/contributing.md b/docs/contributing.md
index b1b464a..48af982 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -198,6 +198,19 @@ poetry version patch  # or minor, or major, or pre-release
 
 For the full usage, please refer to the [poetry documentation](https://python-poetry.org/docs/cli/#version).
 
+## Publish a new version to GitHub and PyPI
+
+Super easy:
+
+```bash
+git tag vX.Y.Z
+git push --tags
+```
+
+The GitHub action will automatically build and publish the wheels to PyPI. You can check the status of the build in the [Actions tab](https://github.com/ssc-oscar/python-woc/actions).
+
+The pipeline also drafts GitHub releases. Navigate to the [Releases tab](https://github.com/ssc-oscar/python-woc/releases) to edit the release notes and publish the release.
+
 ## Add new mappings to python-woc
 
 ### `woc.get_values`