apunkt/trustgraph
1
0
Fork 0
mirror of https://github.com/trustgraph-ai/trustgraph.git synced 2026-05-02 20:03:19 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Dev guide update

Browse source
This commit is contained in:
Cyber MacGeddon 2024-10-03 17:43:23 +01:00
parent bf358f5daf
commit cea22345ea
1 changed files with 19 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

32
DEVELOPER_GUIDE.md
View file

@ -3,15 +3,18 @@ To do a public release you need to...
- Get the git directory ready for the release - Get the git directory ready for the release
- Tag the repo - Tag the repo e.g.
```
git tag -a v1.2.3 -m '' git tag -a v1.2.3 -m ''
git push --tags git push --tags
```
- Generate the deploy templates - Generate the deploy templates, don't add the `v` to the version number.
```
templates/generate-all deploy.zip 1.2.3 templates/generate-all deploy.zip 1.2.3
```
(Creates a deploy.zip file) Don't add 'v' to the version number
- Release - Release
@ -21,20 +24,16 @@ To do a public release you need to...
- At the bottom of the form, find the upload pad, click that and add the - At the bottom of the form, find the upload pad, click that and add the
deploy.zip created earlier deploy.zip created earlier
- Create Python packages - Create Python packages. You need a PyPi token with access to our repos
- make packages - make packages
- make pypi-upload - make pypi-upload
You need a PyPi token with access to our repos - Create containers. You need a docker hub token with acccess to our repos
- Create containers
- make - make
- make push - make push
You need a docker hub token with acccess to our repos
To do a local build, you need to... To do a local build, you need to...
- Consider what version you want to build at, and change this in Makefile. - Consider what version you want to build at, and change this in Makefile.
@ -42,13 +41,20 @@ To do a local build, you need to...
the public repos. You could stick with the version that's there, or the public repos. You could stick with the version that's there, or
change to 0.0.0 if you're paranoid about pushing something accidentally. change to 0.0.0 if you're paranoid about pushing something accidentally.
- If you changed the version to generate templates with your version - If you changed the version to generate templates with your version, or
changed deployment templates, you need to recreate launch assets to
a deploy.zip file:
```
templates/generate-all deploy.zip V.V.V templates/generate-all deploy.zip V.V.V
```
- make - Build containers
```
make
```
That builds containers.
- If you changed anything which affects command line stuff (which maybe - If you changed anything which affects command line stuff (which maybe
you could do if you changed schemas), then you could do if you changed schemas), then