From 59810e380831cd430f01ae2ac85c5bb0821c31d0 Mon Sep 17 00:00:00 2001 From: Talley Lambert Date: Sat, 25 Jan 2025 15:44:16 -0500 Subject: [PATCH 1/2] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index a491d4a..e738024 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,16 @@ print(vec_float) ## How? `witty` invokes `cython` to compile the module given as a PYX string (just like it would compile it during build time). The compiled module ends up in the Cython cache directory, with a hash build from the content of the PYX string. Repeated calls to `compile_module` will only invoke the compiler if the exact PYX string has not been compiled before (or if `force_rebuild==True`). Compilation is protected by a file lock, i.e., concurrent calls to `compile_module` are safe. + + +## For developers + +To push a new release, make sure you've pulled main and are definitely the commit you want to release, +then tag a commit and push to github: + +```sh +git tag -a vX.Y.Z -m vX.Y.Z +git push upstream --follow-tags +``` + +The deploy is handled by `workflows/ci.yml` From f555d0a6f614b5ad8ae1bc20a40dcfeff2f4ba48 Mon Sep 17 00:00:00 2001 From: Talley Lambert Date: Sat, 25 Jan 2025 15:54:14 -0500 Subject: [PATCH 2/2] fix typo --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e738024..2d2b74c 100644 --- a/README.md +++ b/README.md @@ -59,15 +59,14 @@ print(vec_float) `witty` invokes `cython` to compile the module given as a PYX string (just like it would compile it during build time). The compiled module ends up in the Cython cache directory, with a hash build from the content of the PYX string. Repeated calls to `compile_module` will only invoke the compiler if the exact PYX string has not been compiled before (or if `force_rebuild==True`). Compilation is protected by a file lock, i.e., concurrent calls to `compile_module` are safe. - ## For developers -To push a new release, make sure you've pulled main and are definitely the commit you want to release, -then tag a commit and push to github: +To push a new release, make sure you've pulled main and are definitely on +the commit you want to release, then tag a commit and push to github: ```sh git tag -a vX.Y.Z -m vX.Y.Z git push upstream --follow-tags ``` -The deploy is handled by `workflows/ci.yml` +The deploy is handled by [`workflows/ci.yaml`](.github/workflows/ci.yaml#L44)