Skip to content

Commit

Permalink
Update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JWCook committed Jun 30, 2024
1 parent 8c9f59a commit 233be55
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
14 changes: 12 additions & 2 deletions packaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,23 @@ This directory contains scripts and config for building Naturtag packages in the
* Taxonomy full text search database (optional download)

# Release steps

## Build taxonomy db
* Locally build full taxonomy FTS database with `build_taxon_db.py`. For reference, see:
* [pyinaturalist_convert.dwca](https://pyinaturalist-convert.readthedocs.io/en/stable/modules/dwca.html)
* [pyinaturalist_convert.taxonomy](https://pyinaturalist-convert.readthedocs.io/en/stable/modules/taxonomy.html)
* [pyinaturalist_convert.fts](https://pyinaturalist-convert.readthedocs.io/en/stable/modules/fts.html)
* Export subset of db (English language, common species only) with `export_taxa.sh`
* Commit to repo under `assets/data/taxonomy.tar.gz`
* Export full db with `export_taxa_full.sh`
* This will create a file `taxonomy-full.tar.gz` to upload later

## Windows Installer
* Update version in `pyproject.toml` and Actual Installer config (`naturtag.aip`)
* On a Windows machine or VM, build the project locally and create an installer with Actual Installer.
* See steps in `build_win.ps1` for details (not fully automated; requires GUI interaction)

## Release
* Create and push new git tag. This will trigger jobs to build packages and create a new GitHub release.
* Export full db with `export_taxa_full.sh`
* After the release jobs complete, manually upload this to the release assets
* Manually upload full taxonomy db (`taxonomy-full.tar.gz`) to the new release's assets
* Manually upload Windows installer (`naturtag-installer.exe`) to the new release's assets
9 changes: 3 additions & 6 deletions packaging/build_win.ps1
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Build pyinstaller package prior to creating Windows installer

# Create virtualenv
# python -m venv $env:USERPROFILE\.virtualenvs\naturtag
# Create virtualenv (if needed)
# python3.11 -m venv $env:USERPROFILE\.virtualenvs\naturtag

# Install poetry
# Install poetry (if needed)
# Invoke-WebRequest -Uri https://install.python-poetry.org -OutFile install-poetry.py
# python install-poetry.py --preview
# ~\AppData\Roaming\Python\Scripts\poetry.exe config virtualenvs.create false
Expand All @@ -20,6 +20,3 @@ pyinstaller -y packaging\naturtag.spec
# 2. Run installer
# 3. Open Naturtag and test basic features
Invoke-Item packaging\naturtag.aip

# Launch InstallForge
# Invoke-Item packaging\naturtag.ifp

0 comments on commit 233be55

Please sign in to comment.