diff --git a/.env b/.env index 7823e65..d03d133 100644 --- a/.env +++ b/.env @@ -7,5 +7,5 @@ GODOT_VERSION=4.2.1-stable # Game GAME_NAME=HazyRoad -GAME_VERSION=1.0.3 +GAME_VERSION=1.0.4 GAME_ITCHIO_KEY=hazy-road diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c05084e..7c07ce9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -49,7 +49,8 @@ repos: LICENSE.md| LICENSES/| public/| - README.md + README.md| + RELEASING.md ) - id: format-shaders name: format shaders diff --git a/.reuse/dep5 b/.reuse/dep5 index 83532e2..c01398d 100644 --- a/.reuse/dep5 +++ b/.reuse/dep5 @@ -44,6 +44,11 @@ Copyright: 2022 Savo Vuksan License: MIT Source: https://github.com/SavoVuksan/EasyMenus +Files: addons/quiver_analytics/* +Copyright: 2023 Quiver +License: MIT +Source: https://github.com/quiver-dev/quiver-analytics-godot-plugin/ + # Models Files: assets/models/car/* diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a489c8..0ac2bbc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,15 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ## [Unreleased] ### Added +### Changed +### Deprecated +### Removed +### Fixed +### Security +### Dependencies + +## [1.0.4] +### Added - Add custom bootsplash ([#25](https://github.com/MechanicalFlower/HazyRoad/pull/25)) - Add Quiver Analtics ([#28](https://github.com/MechanicalFlower/HazyRoad/pull/28)) ### Changed @@ -42,7 +51,8 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) ### Fixed - Include `.godot` folder to fix the CI build step ([#2](https://github.com/MechanicalFlower/HazyRoad/pull/2)) -[Unreleased]: https://github.com/MechanicalFlower/HazyRoad/compare/1.0.3...HEAD +[Unreleased]: https://github.com/MechanicalFlower/HazyRoad/compare/1.0.4...HEAD +[1.0.4]: https://github.com/MechanicalFlower/HazyRoad/compare/1.0.3...1.0.4 [1.0.3]: https://github.com/MechanicalFlower/HazyRoad/compare/1.0.2...1.0.3 [1.0.2]: https://github.com/MechanicalFlower/HazyRoad/compare/1.0.1...1.0.2 [1.0.1]: https://github.com/MechanicalFlower/HazyRoad/compare/1.0.0...1.0.1 diff --git a/CREDITS.md b/CREDITS.md index fa04969..1785e6b 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -8,6 +8,7 @@ - "[addons/dialogue_label/*](https://github.com/night-glider/Dialogue-Label)" by **night-glider** licensed under [MIT](./LICENSES/MIT.txt) - "[addons/UniversalFade/*](https://github.com/KoBeWi/Godot-Universal-Fade)" by **Tomek** licensed under [MIT](./LICENSES/MIT.txt) - "[addons/EasyMenus/*](https://github.com/SavoVuksan/EasyMenus)" by **Savo Vuksan** licensed under [MIT](./LICENSES/MIT.txt) +- "[addons/quiver_analytics/*](https://github.com/quiver-dev/quiver-analytics-godot-plugin/)" by **Quiver** licensed under [MIT](./LICENSES/MIT.txt) ## Models - "[assets/models/car/*](https://ggbot.itch.io/psx-style-cars)" by **GGBotNet** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) - "[assets/models/crowbar/*](https://opengameart.org/content/crowbar)" by **Clint Bellanger** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) @@ -37,4 +38,4 @@ - "[shaders/panoramic_textured_sky_with_clouds.gdshader](https://godotshaders.com/shader/panoramic-textured-sky-with-clouds/)" by **Gyrth** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) - "[shaders/psx_model.gdshader](https://godotshaders.com/shader/ps1-psx-model/)" by **Grau** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) - "[shaders/psx_postprocessing.gdshader](https://godotshaders.com/shader/ps1-psx-postprocessing/)" by **Grau** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) -- "[shaders/vignette.gdshader](https://godotshaders.com/shader/vignette)" by **crocoby** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) +- "[shaders/vignette.gdshader](https://godotshaders.com/shader/vignette/)" by **crocoby** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) diff --git a/README.md b/README.md index ca2a8b5..3e0a6fd 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,7 @@ It's not the fanciest game, but hey, neither is life. So, go on, tackle that cro We welcome community contributions to this project. Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started. + +## Releasing + +Please read our [Release Guide](RELEASING.md) for more information on how we manage our releases. diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..9b50d5f --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,37 @@ +# Releasing + +This document outlines the release policy for games within our organization. + +## Versioning + +We adhere to [Semantic Versioning](https://semver.org/) for our releases, following the `MAJOR.MINOR.PATCH` format. + +## Branching + +Our projects maintain the following active branches: +* **main**: This branch represents the next release and is where all merges take place. + +## Continuous Delivery + +We use [Github Actions](https://docs.github.com/en/actions) to automate the release process. When a new version is released, the CI pipeline automatically triggers a publication on the **GitHub** and **itch.io** platforms. + +## Steps to release + +1. Update the version in the code base + - Update the `.env` file + 1. Change the `GAME_VERSION` variable to the new version + 2. Run the `bump-version` recipe + - Update the `CHANGELOG.md` file + 1. Replace the `Unreleased` title with the new version + 2. Add a link for the new version at the bottom of the changelog + 3. Create a new `Unreleased` section +2. Merge the change into the `main` branch + 1. Create a branch `release-` from the `main` branch + 2. Commit the changes with `"chore: bump version to for release"` as message + 3. Push the branch to the remote repository + 4. Create a pull request targeting the `main` branch + 5. Review the changes in the pull request and ensure they meet the release criteria + 6. Merge the pull request into the `main` branch +3. Tag the `main` branch + 1. Tag the `main` branch with the release version + 2. Push the tags to the remote repository diff --git a/export_presets.cfg b/export_presets.cfg index e2c64ab..9eddedb 100644 --- a/export_presets.cfg +++ b/export_presets.cfg @@ -35,8 +35,8 @@ application/modify_resources=true application/icon="" application/console_wrapper_icon="" application/icon_interpolation=4 -application/file_version="1.0.2.20240115" -application/product_version="1.0.2.20240115" +application/file_version="1.0.4.20240322" +application/product_version="1.0.4.20240322" application/company_name="Mechanical Flower" application/product_name="HazyRoad" application/file_description="" @@ -131,7 +131,7 @@ application/bundle_identifier="io.itch.MechanicalFlower" application/signature="" application/app_category="Games" application/short_version="1.0" -application/version="1.0.2" +application/version="1.0.4" application/copyright="2023-present Mechanical Flower" application/copyright_localized={} application/min_macos_version="10.12" diff --git a/project.godot b/project.godot index b4a4a6e..2ce80d8 100644 --- a/project.godot +++ b/project.godot @@ -19,7 +19,7 @@ logger/break_on_error=false config/name="Hazy Road" config/description="You're on your way home and come to a crossroads where a barrier is blocking your way. You decide to get out of your car to find a way through." -config/version="1.0.2" +config/version="1.0.4" run/main_scene="res://scenes/ui/godot_bootstrap.tscn" config/features=PackedStringArray("4.2") boot_splash/bg_color=Color(0, 0, 0, 1)