Skip to content

Commit

Permalink
Update README.md with initial build procedure
Browse files Browse the repository at this point in the history
  • Loading branch information
vjf authored Dec 23, 2024
1 parent f22c921 commit 1ef4417
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,21 @@ Use the '-g' flag to generate COLLADA files

[batch_proc.py](web_build/batch_proc.py) is a simple batch script used to convert the GOCAD models for the website.


### Building a borehole database

[make_boreholes.py](web_build/make_boreholes.py) is a script to create a database of NVCL borehole objects to display within the model. See this [README](web_build/README.md) for more information.

### Release Procedure

1. Tag with "PORTAL_RELEASE_YYYYMMDD" annotated tag
```
git tag -a PORTAL_RELEASE_20241223 -m "December 2024 Release"
git push --tags origin master
```
2. The 'release_backend.yml' action will create a release at this tag
3. Once step 2 is complete, run the 'release_models.yml' action inputting the tag name
4. The 'release_models.yml' will build all the model files and insert them into the release

### Code Documentation

Autogenerated API Documentation is available [here](https://auscope.github.io/geomodel-2-3dweb/)
Expand Down

0 comments on commit 1ef4417

Please sign in to comment.