Maintainer notes¶
Note
currently this page is only relevant to @jacksund
Making a release¶
To make a new release, you must follow these steps:
-
Update the Simmate version number in
pyproject.toml
(here) -
Update the changelog with the new release and date
-
Ensure all tests pass when using the pre-built database. Otherwise, you need to (i) make a new one using the commands below, (ii) rename your db file to something like
prebuild-2022-07-05.sqlite3
, (iii) compress the db file to a zip file, (iv) upload it to the Simmate CDN, and (iii) update thearchive_filename
insimmate.database.third_parties.utilites.load_default_sqlite3_build
.simmate database reset --confirm-delete --no-use-prebuilt simmate database load-remote-archives
-
Make a release on Github (which will automatically release to pypi)
-
Wait for the autotick bot to open a pull request for the simmate feedstock. This can take up to 24hrs, but you can check the status here (under "Queued").
-
Make sure the autotick bot made the proper changes before merging. If there were any major changes, you can use grayskull to help update the version number, sha256, and dependencies.
-
After merging, it takes the conda-forge channels 30min or so to update their indexes. Afterwards, you can test the conda install with:
# for a normal release conda create -n my_env -c conda-forge simmate -y # as an extra, make sure spyder can also be installed in the same env conda install -n my_env -c conda-forge spyder -y
Website CSS¶
The Hyper theme described in our main docs here must be built and hosted separately from any Simmate server to abide by licensing. The build/host the assests, follow these steps:
- download hyper theme (private access): e.g.
Hyper_v4.6.0.zip
- unpack the zip file and navigate to this directory:
cd Hyper_v4.6.0/Bootstrap_5x/Hyper/
- install prereqs into a new conda env and activate it
conda create -n hyper -c conda-forge nodejs yarn git conda activate hyper
- install gulp using npm (conda install of gulp doesn't work)
npm install gulp -g
- in the main dir, install all hyper dependencies using the
yarn.lock
fileyarn install
- edit any themes/colors in the following files (e.g. change primary to
#0072ce
)/src/assests/scss/config/saas/ >> go into each folder's _variables.scss
- Build the assets
gulp build
- Upload assests (in
dist
folder) to your cdn for serving