Creating a Release

To release Amidst, follow these steps:

1. Update the metadata on master
2. checkout the branch master
3. update information in src/main/resources/amidst/metadata.properties
4. update wrapper information in /travis-ci/{wrapper-for-mac, wrapper-for-windows}/pom.xml

5. commit and push

6. Update the branch releases

7. checkout the branch releases
8. fast-forward merge the branch master into the branch releases

9. push

10. Create the new release tag

11. create and push the tag

12. tags are named like this:

    • v4.0 for stable releases
    • v4.0-beta5 for pre-releases

13. Update the release information on Github

14. wait for travis ci to build Amidst, it will attach the executable jar, zip and exe files to the release on Github
15. add meaningful release notes

16. make it a pre-release, if necessary

17. Update the update document (only if not a pre-release)

18. the update document is used by Amidst to check for updates
19. if you have write access, you can edit the update document here
    • https://github.com/toolbox4minecraft/amidst/blob/gh-pages/api/update-information.json

20. to generate the update document, you can use the devtool GenerateUpdateInformationJson

    • it uses the information from the file src/main/resources/amidst/metadata.properties
    • you can add an optional message which is displayed to the user, use this with care

21. Update the Amidst entry in the Minecraft wiki (only if not a pre-release)

22. Update third party package managers (only if not a pre-release)

23. for homebrew cask there seems to be a third party that updates the package information
    • #128
    • https://github.com/caskroom/homebrew-cask/blob/master/Casks/amidst.rb