Skip to content

Commit

Permalink
update scripts to include verion 4.26 and document release
Browse files Browse the repository at this point in the history
  • Loading branch information
maxklenk committed Jan 27, 2021
1 parent d8061dd commit 64a840f
Show file tree
Hide file tree
Showing 6 changed files with 136 additions and 8 deletions.
37 changes: 37 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Development

## Branches

This repository contains a branch for each Engine Version. Only perform changes in one of these branches if the changes are specific for this version. All other changes are made in the `master` - this branch uses our base version `UE/4.20`.

- UE/4.16 [deprecated]
- UE/4.17 [deprecated]
- UE/4.18 [deprecated]
- UE/4.19 [deprecated]
- UE/4.20 = master
- UE/4.21 = master + changed EngineVersion
- UE/4.22 = master + changed EngineVersion
- UE/4.23 = master + changed EngineVersion
- UE/4.24 = master + changed EngineVersion
- UE/4.25 = master + changed EngineVersion
- UE/4.26 = master + changed EngineVersion

## Release

The following scripts help to perform a release.

1. Ensure that all nessessary changes have been made in the `master` branch.

* Increase Version in StomtPlugin.uplugin
* Update version number in StomtPlugin.uplugin
* Update version number in StomtTrack.cpp line 36
* commit changes "git commit -am 'bump version to X.X.X"
* create tag "git tag -a vX.X.X"

2. Use `sh scripts/delete_branches.sh` to remove local changes in other branches.

3. Update the version branches by running `sh scripts/update_branches.sh`. Confirm the merges and merge commits.

4. Push the updated branches to GitHub by running `sh scripts/push_branches.sh`.

5. Now pack the version archives `sh pack.sh` and upload them for the store.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
[4.22](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.22),
[4.23](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.23),
[4.24](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.24),
[4.25](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.25))**

[4.25](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.25),
[4.26](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.26)
)**

<p align="center">
<img alt="STOMT Unreal Engine feedback integration" src="https://i.imgur.com/1i1eCrb.jpg" />
Expand Down
33 changes: 27 additions & 6 deletions pack.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# RESET
git add .
git stash
git checkout master


# next (4.20)
git add .
git stash
Expand All @@ -9,7 +15,7 @@ mv CONTRIBUTING.md Docs/CONTRIBUTING.md

# zip
rm ../stomt-unreal-plugin-4-20.zip
zip -r -X ../stomt-unreal-plugin-4-20.zip . -x *.git* -x pack.sh -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*
zip -r -X ../stomt-unreal-plugin-4-20.zip . -x *.git* -x pack.sh -x scripts/ -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*


# next (4.21)
Expand All @@ -23,7 +29,7 @@ mv CONTRIBUTING.md Docs/CONTRIBUTING.md

# zip
rm ../stomt-unreal-plugin-4-21.zip
zip -r -X ../stomt-unreal-plugin-4-21.zip . -x *.git* -x pack.sh -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*
zip -r -X ../stomt-unreal-plugin-4-21.zip . -x *.git* -x pack.sh -x scripts/ -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*


# next (4.22)
Expand All @@ -37,7 +43,7 @@ mv CONTRIBUTING.md Docs/CONTRIBUTING.md

# zip
rm ../stomt-unreal-plugin-4-22.zip
zip -r -X ../stomt-unreal-plugin-4-22.zip . -x *.git* -x pack.sh -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*
zip -r -X ../stomt-unreal-plugin-4-22.zip . -x *.git* -x pack.sh -x scripts/ -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*


# next (4.23)
Expand All @@ -51,7 +57,7 @@ mv CONTRIBUTING.md Docs/CONTRIBUTING.md

# zip
rm ../stomt-unreal-plugin-4-23.zip
zip -r -X ../stomt-unreal-plugin-4-23.zip . -x *.git* -x pack.sh -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*
zip -r -X ../stomt-unreal-plugin-4-23.zip . -x *.git* -x pack.sh -x scripts/ -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*


# next (4.24)
Expand All @@ -65,7 +71,7 @@ mv CONTRIBUTING.md Docs/CONTRIBUTING.md

# zip
rm ../stomt-unreal-plugin-4-24.zip
zip -r -X ../stomt-unreal-plugin-4-24.zip . -x *.git* -x pack.sh -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*
zip -r -X ../stomt-unreal-plugin-4-24.zip . -x *.git* -x pack.sh -x scripts/ -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*


# next (4.25)
Expand All @@ -79,9 +85,24 @@ mv CONTRIBUTING.md Docs/CONTRIBUTING.md

# zip
rm ../stomt-unreal-plugin-4-25.zip
zip -r -X ../stomt-unreal-plugin-4-25.zip . -x *.git* -x pack.sh -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*
zip -r -X ../stomt-unreal-plugin-4-25.zip . -x *.git* -x pack.sh -x scripts/ -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*


# next (4.26)
git add .
git stash
git checkout UE/4.26

# move root files
mv README.md Docs/README.md
mv CONTRIBUTING.md Docs/CONTRIBUTING.md

# zip
rm ../stomt-unreal-plugin-4-26.zip
zip -r -X ../stomt-unreal-plugin-4-26.zip . -x *.git* -x pack.sh -x scripts/ -x *.DS_Store* -x LICENSE.md -x Binaries/ -x Intermediate/ -x Binaries/**\* -x Intermediate/**\*


## FINSIH
# clean
git add .
git stash
Expand Down
14 changes: 14 additions & 0 deletions scripts/delete_branches.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# RESET
git add .
git stash
git checkout master


# remove local braches (to remove changes in them)
git branch -D UE/4.20
git branch -D UE/4.21
git branch -D UE/4.22
git branch -D UE/4.23
git branch -D UE/4.24
git branch -D UE/4.25
git branch -D UE/4.26
18 changes: 18 additions & 0 deletions scripts/push_branches.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# RESET
git add .
git stash
git checkout master

# push tags
git push --tags

# push all updates
git push origin master \
UE/4.20 \
UE/4.21 \
UE/4.22 \
UE/4.23 \
UE/4.24 \
UE/4.25 \
UE/4.26 \

37 changes: 37 additions & 0 deletions scripts/update_branches.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# RESET
git add .
git stash
git checkout master


# UE/4.20
git checkout UE/4.20
git merge master

# UE/4.21
git checkout UE/4.21
git merge master

# UE/4.22
git checkout UE/4.22
git merge master

# UE/4.23
git checkout UE/4.23
git merge master

# UE/4.24
git checkout UE/4.24
git merge master

# UE/4.25
git checkout UE/4.25
git merge master

# UE/4.26
git checkout UE/4.26
git merge master


## FINISH
git checkout master

0 comments on commit 64a840f

Please sign in to comment.