Editor development workflow

The Athene2 Editor has its own repository and is included as a submodule in src/assets/athene2-editor. This pages explains the workflow arising from this setup.

Fetching the locked version

The following command updates the athene2-editor submodule to the locked commit specified in the athene2 repository.

git submodule update --init --recursive

Committing changes to athene2-editor

Firstly, add your athene2-editor fork as a remote to the submodule.

cd src/assets/athene2-editor
git remote add REMOTE git@github.com:USER/athene2-editor.git

Then you can make your changes directly to src/assets/athene2-editor and commit them as usual.

cd src/assets/athene2-editor
git checkout -b BRANCH
git add .
git commit
git push -u REMOTE BRANCH

Update the locked version

Pull the changes in src/assets/athene2-editor and commit src/assets/athene2-editor. Here, src/assets/athene2-editor will be treated as a file by the athene2 repository and contains the reference to the locked athene2-editor commit.

git checkout -b BRANCH
cd src/assets/athene2-editor
git pull origin master
cd ..
git add athene2-editor
git commit
git push -u REMOTE BRANCH