From c86fee79168882d5086dc99bac229af5df58432e Mon Sep 17 00:00:00 2001 From: florianvazelle Date: Thu, 25 Jul 2024 22:56:22 +0200 Subject: [PATCH] chore: improving repo hygiene --- .github/workflows/release-packaging.yml | 37 -------- .pre-commit-config.yaml | 16 +++- .reuse/REUSE-compliant.svg | 1 + .reuse/dep5 | 89 +++++++++++++++++ CHANGELOG.md | 14 +++ CONTRIBUTING.md | 62 ++++++++++++ CREDITS.md | 21 ++++ Justfile | 4 + LICENSES/CC0-1.0.txt | 121 ++++++++++++++++++++++++ LICENSES/LicenseRef-Pixabay | 21 ++++ LICENSES/MIT.txt | 9 ++ README.md | 27 +++++- RELEASING.md | 37 ++++++++ generate_credits.py | 63 ++++++++++++ project.godot | 4 +- 15 files changed, 481 insertions(+), 45 deletions(-) create mode 100644 .reuse/REUSE-compliant.svg create mode 100644 .reuse/dep5 create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 CREDITS.md create mode 100644 LICENSES/CC0-1.0.txt create mode 100644 LICENSES/LicenseRef-Pixabay create mode 100644 LICENSES/MIT.txt create mode 100644 RELEASING.md create mode 100755 generate_credits.py diff --git a/.github/workflows/release-packaging.yml b/.github/workflows/release-packaging.yml index 5788f42..2746142 100644 --- a/.github/workflows/release-packaging.yml +++ b/.github/workflows/release-packaging.yml @@ -62,43 +62,6 @@ jobs: path: dist/* retention-days: 1 - deploy: - runs-on: ubuntu-22.04 - timeout-minutes: 30 - needs: [check] - - if: github.ref == 'refs/heads/main' - - steps: - - uses: actions/checkout@v4 - - uses: extractions/setup-just@v2 - - - name: Load dotenv - run: just ci-load-dotenv - - - name: Cache Godot - uses: actions/cache@v4 - with: - path: | - ~/.mkflower/bin - ~/.local/share/godot/export_templates - key: ${{ env.godot_version }} - - - name: Export - run: just export-web - - # Installing rsync is needed in order to deploy to GitHub Pages. Without it, the build will fail. - - name: Install rsync - run: | - sudo apt-get update && sudo apt-get install -y rsync - - - name: Deploy to GitHub Pages - uses: JamesIves/github-pages-deploy-action@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - branch: gh-pages - folder: build/web - publish: runs-on: ubuntu-22.04 timeout-minutes: 30 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1555150..b118191 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,3 +1,9 @@ +ci: + autofix_prs: false + autoupdate_commit_msg: 'chore(deps): Bump pre-commit hooks' + autoupdate_schedule: weekly + skip: [format-shaders] + repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.4.0 @@ -15,6 +21,10 @@ repos: - id: end-of-file-fixer # Checks for ending with a newline - id: mixed-line-ending # Consistent LF or CRLF - id: trailing-whitespace # No trailing whitespace +- repo: https://github.com/fsfe/reuse-tool + rev: v4.0.3 + hooks: + - id: reuse - repo: https://github.com/codespell-project/codespell rev: v2.2.5 hooks: @@ -36,14 +46,18 @@ repos: exclude: | (?x)^( .godot/| + .reuse/| addons/gd-plug/| assets/models/| + CHANGELOG.md| + CONTRIBUTING.md| CREDITS.md| Justfile| LICENSE.md| LICENSES/| public/| - README.md + README.md| + RELEASING.md ) - id: format-shaders name: format shaders diff --git a/.reuse/REUSE-compliant.svg b/.reuse/REUSE-compliant.svg new file mode 100644 index 0000000..5b2a2f4 --- /dev/null +++ b/.reuse/REUSE-compliant.svg @@ -0,0 +1 @@ +REUSE: compliantREUSEcompliant diff --git a/.reuse/dep5 b/.reuse/dep5 new file mode 100644 index 0000000..b0deb50 --- /dev/null +++ b/.reuse/dep5 @@ -0,0 +1,89 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: Frogger3D +Upstream-Contact: Florian Vazelle +Source: https://github.com/MechanicalFlower/Frogger3D + +Files: * +Copyright: 2024-present Florian Vazelle +License: MIT + +# Addons + +Files: addons/debug_menu/* +Copyright: 2023-present Hugo Locurcio and contributors +License: MIT +Source: https://github.com/godot-extended-libraries/godot-debug-menu + +Files: addons/gd-plug/* +Copyright: 2021 Tan Jian Ping +License: MIT +Source: https://github.com/imjp94/gd-plug + +# Models + +Files: assets/models/* +Copyright: 2022 Kenney +License: CC0-1.0 +Source: https://www.kenney.nl/ + +# Fonts + +Files: assets/fonts/ka1.ttf +Copyright: 2005 Vic Fieger +License: CC0-1.0 +Source: https://www.dafont.com/karmatic-arcade.font + +Files: assets/fonts/vcr_osd_mono.001.ttf +Copyright: 2014 Riciery Leal +License: CC0-1.0 +Source: https://www.dafont.com/vcr-osd-mono.font + +# Sounds + +Files: assets/sounds/sfx/river/running-water.mp3 +Copyright: 2022 JackClearyMusic +License: LicenseRef-Pixabay +Source: https://pixabay.com/pt/sound-effects/running-water-48518/ + +Files: assets/sounds/sfx/river/water-splosh.mp3 +Copyright: 2022 benj500 +License: LicenseRef-Pixabay +Source: https://pixabay.com/pt/sound-effects/running-water-48518/ + +Files: assets/sounds/sfx/river/water-stream.mp3 +Copyright: 2022 +License: LicenseRef-Pixabay +Source: https://pixabay.com/pt/sound-effects/water-stream-108384/ + +Files: assets/sounds/sfx/road/car-ambiant.mp3 +Copyright: 2022 jackthemurray +License: LicenseRef-Pixabay +Source: https://pixabay.com/pt/sound-effects/inside-car-noise-while-driving-29978/ + +Files: assets/sounds/sfx/road/car-horn.mp3 +Copyright: 2021 keweldog +License: LicenseRef-Pixabay +Source: https://pixabay.com/pt/sound-effects/car-horn-6408/ +Comment: Edited by Florian Vazelle, with audacity, to start directly on the horn sound + +Files: assets/sounds/sfx/collect.mp3 +Copyright: 2021 Wagna +License: LicenseRef-Pixabay +Source: https://pixabay.com/pt/sound-effects/collect-5930/ + +# Shaders + +Files: shaders/sky.gdshader +Copyright: 2023 axilirate +License: CC0-1.0 +Source: https://godotshaders.com/shader/stylized-sky-shader-with-clouds/ + +Files: shaders/checkbox.gdshader +Copyright: 2021 Lordinator +License: CC0-1.0 +Source: https://godotshaders.com/shader/world-coordinates-grid-bw-shader/ + +Files: shaders/water.gdshader +Copyright: 2014 ScriptedWave +License: CC0-1.0 +Source: https://godotshaders.com/shader/stylized-water-shader-2/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ac1f769 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# CHANGELOG +Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) + +## [Unreleased] +### Added +### Changed +### Deprecated +### Removed +### Fixed +### Security +### Dependencies + +[Unreleased]: https://github.com/MechanicalFlower/Frogger3D/compare/0.1.0...HEAD +[0.1.0]: https://github.com/MechanicalFlower/Frogger3D/commits/0.1.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a9750b1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,62 @@ +# Contributing + +We welcome contributions to our open source Godot + game project! There are many ways you can help, + including reporting bugs, improving documentation, + and contributing code. + +## Code of Conduct + +We value the participation of every member of our + community and want to ensure that everyone + has an enjoyable and fulfilling experience. As + such, we have adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as + our code of conduct. By participating in this + project, you agree to abide by its terms. + +## Contributing Code + +To contribute code to the project, follow these steps: + +1. Fork the repository to your own GitHub account. +2. Clone the repository to your local machine. +3. Create a new branch for your changes. +4. Make your changes and commit them to your local repository. +5. Push your changes to your forked repository on GitHub. +6. Create a pull request from your forked repository to the original repository. + +Please note that all code contributions should + pass the continuous integration (CI) checks + that are set up for the project. These checks + ensure that the code is well-formatted and + that tests are passing. + + +## Reporting Bugs + +If you find a bug in the project, please report + it by creating an issue in the repository's issue + tracker. Be sure to include as much information + as possible, including the steps to reproduce + the bug and any relevant error messages. + +## Improving Documentation + +If you would like to improve the documentation + for the project, you can do so by submitting a + pull request with your changes. Please follow + the same process as for contributing code, and + make sure that your changes are properly formatted + and well-written. + +## Questions and Feedback + +If you have any questions or feedback about the + project, don't hesitate to reach out! You can + create an issue in the repository's issue tracker, + or contact us directly through our website or + social media channels. + +Thank you for considering contributing to our + open source Godot game project! We appreciate + your help and look forward to working with you. diff --git a/CREDITS.md b/CREDITS.md new file mode 100644 index 0000000..2220a29 --- /dev/null +++ b/CREDITS.md @@ -0,0 +1,21 @@ +# Credits + +## Addons +- "[addons/debug_menu/*](https://github.com/godot-extended-libraries/godot-debug-menu)" by **Hugo Locurcio and contributors** licensed under [MIT](./LICENSES/MIT.txt) +- "[addons/gd-plug/*](https://github.com/imjp94/gd-plug)" by **Tan Jian Ping** licensed under [MIT](./LICENSES/MIT.txt) +## Models +- "[assets/models/*](https://www.kenney.nl/)" by **Kenney** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) +## Fonts +- "[assets/fonts/ka1.ttf](https://www.dafont.com/karmatic-arcade.font)" by **Vic Fieger** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) +- "[assets/fonts/vcr_osd_mono.001.ttf](https://www.dafont.com/vcr-osd-mono.font)" by **Riciery Leal** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) +## Sounds +- "[assets/sounds/sfx/river/running-water.mp3](https://pixabay.com/pt/sound-effects/running-water-48518/)" by **JackClearyMusic** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt) +- "[assets/sounds/sfx/river/water-splosh.mp3](https://pixabay.com/pt/sound-effects/running-water-48518/)" by **benj500** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt) +- "[assets/sounds/sfx/river/water-stream.mp3](https://pixabay.com/pt/sound-effects/water-stream-108384/)" by **** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt) +- "[assets/sounds/sfx/road/car-ambiant.mp3](https://pixabay.com/pt/sound-effects/inside-car-noise-while-driving-29978/)" by **jackthemurray** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt) +- "[assets/sounds/sfx/road/car-horn.mp3](https://pixabay.com/pt/sound-effects/car-horn-6408/)" by **keweldog** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt) +- "[assets/sounds/sfx/collect.mp3](https://pixabay.com/pt/sound-effects/collect-5930/)" by **Wagna** licensed under [LicenseRef-Pixabay](./LICENSES/LicenseRef-Pixabay.txt) +## Shaders +- "[shaders/sky.gdshader](https://godotshaders.com/shader/stylized-sky-shader-with-clouds/)" by **axilirate** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) +- "[shaders/checkbox.gdshader](https://godotshaders.com/shader/world-coordinates-grid-bw-shader/)" by **Lordinator** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) +- "[shaders/water.gdshader](https://godotshaders.com/shader/stylized-water-shader-2)" by **ScriptedWave** licensed under [CC0-1.0](./LICENSES/CC0-1.0.txt) diff --git a/Justfile b/Justfile index da5a0d9..e4c910f 100644 --- a/Justfile +++ b/Justfile @@ -141,6 +141,10 @@ fmt: just venv pip install pre-commit==3.* just venv pre-commit run -a +# Generate the CREDTIS.md file +credits: + just venv python ./generate_credits.py + # === Godot === # # Recipes for managing the Godot binary. diff --git a/LICENSES/CC0-1.0.txt b/LICENSES/CC0-1.0.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/LICENSES/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/LICENSES/LicenseRef-Pixabay b/LICENSES/LicenseRef-Pixabay new file mode 100644 index 0000000..f5ac746 --- /dev/null +++ b/LICENSES/LicenseRef-Pixabay @@ -0,0 +1,21 @@ +Content License Summary + +Welcome to Pixabay! Pixabay is a vibrant community of authors, artists and creators sharing royalty-free images, video, audio and other media. We refer to this collectively as "Content". By accessing and using Content, or by contributing Content, you agree to comply with our Content License. + +At Pixabay, we like to keep things as simple as possible. For this reason, we have created this short summary of our Content License which is available in full here. Please keep in mind that only the full Content License is legally binding. +What are you allowed to do with Content? + +Subject to the Prohibited Uses (see below), the Content License allows users to: +✓ Use Content for free +✓ Use Content without having to attribute the author (although giving credit is always appreciated by our community!) +✓ Modify or adapt Content into new works +What are you not allowed to do with Content? + +We refer to these as Prohibited Uses which include: +✕ You cannot sell or distribute Content (either in digital or physical form) on a Standalone basis. Standalone means where no creative effort has been applied to the Content and it remains in substantially the same form as it exists on our website. +✕ If Content contains any recognisable trademarks, logos or brands, you cannot use that Content for commercial purposes in relation to goods and services. In particular, you cannot print that Content on merchandise or other physical products for sale. +✕ You cannot use Content in any immoral or illegal way, especially Content which features recognisable people. +✕ You cannot use Content in a misleading or deceptive way. +✕ You cannot use any of the Content as part of a trade-mark, design-mark, trade-name, business name or service mark. + +Please be aware that certain Content may be subject to additional intellectual property rights (such as copyrights, trademarks, design rights), moral rights, proprietary rights, property rights, privacy rights or similar. It is your responsibility to check whether you require the consent of a third party or a license to use Content. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..2071b23 --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index a514ec3..f3255f8 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,18 @@ ![Godot Badge](https://img.shields.io/badge/godot-4.2-blue?logo=Godot-Engine&logoColor=white) ![license](https://img.shields.io/badge/license-MIT-green?logo=open-source-initiative&logoColor=white) +![reuse](./.reuse/REUSE-compliant.svg) -A [frogger](https://en.wikipedia.org/wiki/Frogger), made with [Godot Engine](https://godotengine.org/). +A [frogger](https://en.wikipedia.org/wiki/Frogger)-like 3D platformer game, made with [Godot Engine](https://godotengine.org/). Download on Github +## About + +Dodge traffic on a busy road, then cross a river by jumping on floating logs and climb a rock to reach the melon. + ## Installation ### From a release @@ -21,9 +26,9 @@ on the Github repository, in the release section. Download the zip archive, accordingly to your OS, and unzip it. -- **Windows**: Double click on `Marble.exe`. -- **MacOS**: Double click on `Marble.app`. -- **Linux**: In a terminal, run `./Marble.x86_64`. +- **Windows**: Double click on `Frogger3D.exe`. +- **MacOS**: Double click on `Frogger3D.app`. +- **Linux**: In a terminal, run `./Frogger3D.x86_64`. ### From source @@ -33,7 +38,7 @@ Download the zip archive, accordingly to your OS, and unzip it. Clone the source locally: ``` -git clone https://github.com/MechanicalFlower/Marble.git +git clone https://github.com/MechanicalFlower/Frogger3D.git ``` You need to install addons first: @@ -75,3 +80,15 @@ just godot > In `just` recipes, the Godot Editor is installed > automatically. This ensure that you > use the right version of the engine. + +## Contributing + +![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg) + +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/generate_credits.py b/generate_credits.py new file mode 100755 index 0000000..04dd34c --- /dev/null +++ b/generate_credits.py @@ -0,0 +1,63 @@ +#!/usr/bin/env python3 +import os +from string import Template + + +def main(): + template = Template(( + '- "[$files]($source)" by **$author** licensed' + ' under [$license](./LICENSES/$license.txt)\n' + )) + + deps = {} + section = None + + with open(".reuse/dep5", "r") as file: + for line in file: + if line.startswith('# '): + section = line[len("# "): -1].lower() + + if section is None: + continue + + if line.startswith("Files: "): + if section not in deps: + deps[section] = [] + + deps[section].append({"files": line[len("Files: "):-1]}) + + elif line.startswith("Copyright: "): + if section not in deps: + deps[section] = [] + + date_author = line[len("Copyright: "):-1].split(" ") + date_author.pop(0) + deps[section][-1]["author"] = " ".join(date_author) + + elif line.startswith("License: "): + if section not in deps: + deps[section] = [] + + deps[section][-1]["license"] = line[len("License: "):-1] + + elif line.startswith("Source: "): + if section not in deps: + deps[section] = [] + + deps[section][-1]["source"] = line[len("Source: "):-1] + + if deps: + with open("CREDITS.md", "w") as file: + file.writelines("# Credits\n\n") + + for key, value in deps.items(): + file.writelines(f"## {key.title()}\n") + for dep in value: + file.writelines(template.substitute(**dep)) + else: + if os.path.exists("CREDITS.md"): + os.remove("CREDITS.md") + + +if __name__ == "__main__": + main() diff --git a/project.godot b/project.godot index 78f887b..aea508c 100644 --- a/project.godot +++ b/project.godot @@ -25,8 +25,8 @@ DebugMenu="*res://addons/debug_menu/debug_menu.tscn" [custom_options] -build_info/commit="10856c7df6fbb74c96a3e1a6ea8aca86904ad5d5" -build_info/date="2024/07/22" +build_info/commit="192721c15074d3d0bd149aafe7b07672aae09fb3" +build_info/date="2024/07/25" [display]