From 1b1696fac3d59300de1814078ab3ee7581578e51 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Mon, 4 Sep 2023 10:54:34 +0200
Subject: Merging upstream version 0.8.2.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .github/release.md | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 102 insertions(+)
 create mode 100644 .github/release.md

(limited to '.github/release.md')

diff --git a/.github/release.md b/.github/release.md
new file mode 100644
index 0000000..d95694d
--- /dev/null
+++ b/.github/release.md
@@ -0,0 +1,102 @@
+# Notes
+
+Notes regarding how to release eos-downloader package
+
+## Package requirements
+
+- `bumpver`
+- `build`
+- `twine`
+
+Also, [Github CLI](https://cli.github.com/) can be helpful and is recommended
+
+## Bumping version
+
+In a branch specific for this, use the `bumpver` tool.
+It is configured to update:
+* pyproject.toml
+
+For instance to bump a patch version:
+```
+bumpver update --patch
+```
+
+and for a minor version
+
+```
+bumpver update --minor
+```
+
+Tip: It is possible to check what the changes would be using `--dry`
+
+```
+bumpver update --minor --dry
+```
+
+## Creating release on Github
+
+Create the release on Github with the appropriate tag `vx.x.x`
+
+## Release version `x.x.x`
+
+> [!IMPORTANT]
+> TODO - make this a github workflow
+
+`x.x.x` is the version to be released
+
+This is to be executed at the top of the repo
+
+1. Checkout the latest version of `main` with the correct tag for the release
+2. Create a new branch for release
+
+   ```bash
+   git switch -c rel/vx.x.x
+   ```
+3. [Optional] Clean dist if required
+
+4. Build the package locally
+
+   ```bash
+   python -m build
+   ```
+5. Check the package with `twine` (replace with your vesion)
+
+    ```bash
+    twine check dist/*
+    ```
+6. Upload the package to test.pypi
+
+    ```bash
+    twine upload -r testpypi dist/eos-downloader-x.x.x.*
+    ```
+7. Verify the package by installing it in a local venv and checking it installs
+   and run correctly (run the tests)
+
+   ```bash
+   # In a brand new venv
+   pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple --no-cache eos-downloader
+   ```
+8. Push to eos-downloader repository and create a Pull Request
+
+    ```bash
+    git push origin HEAD
+    gh pr create --title 'bump: eos-downloader vx.x.x'
+    ```
+9.  Merge PR after review and wait for [workflow](https://github.com/titom73/eos-downloader/blob/main/.github/workflows/release.yml) to be executed.
+
+   ```bash
+   gh pr merge --squash
+   ```
+
+10. Like 7 but for normal pypi
+
+    ```bash
+    # In a brand new venv
+    pip install eos-downloader
+    ```
+
+11. Test installed version
+
+    ```bash
+    eos-downloader --version
+    ```
\ No newline at end of file
-- 
cgit v1.2.3