From f3e86f2429c71e3b8f6cefde3fffdda82a2b7251 Mon Sep 17 00:00:00 2001 From: d10sfan Date: Fri, 5 Jan 2024 09:58:44 -0600 Subject: [PATCH] Add github & CI related items to repo --- .github/FUNDING.yml | 3 + .github/ISSUE_TEMPLATE/bug_report.yml | 60 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 28 ++++++++ .github/pull_request_template.md | 12 ++++ .github/workflows/pr.yml | 63 ++++++++++++++++++ .github/workflows/release.yml | 77 ++++++++++++++++++++++ LICENSE.md | 21 ++++++ README.md | 24 +++++++ 8 files changed, 288 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/pr.yml create mode 100644 .github/workflows/release.yml create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..ae2b63e --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +github: d10sfan diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..38a972f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,60 @@ +name: Bug report +description: Create a report to help us improve the game +labels: bug + +body: + - type: markdown + attributes: + value: | + ## Please fill out the form below with as much information as possible. + ### Attach screenshots if needed to help explain the issue. + - type: input + id: distro + attributes: + label: OS & Version + description: The operating system and version in use, or if web the web browser in use. + validations: + required: true + - type: input + id: gameversion + attributes: + label: Game Version + description: The version of of the game being used. + validations: + required: true + - type: textarea + id: description + attributes: + label: Bug description + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps To Reproduce + description: Describe the steps to reproduce the bug. + placeholder: | + 1. … + 2. … + 3. … + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: Describe the expected behavior + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Context + description: Provide any additional details that do not fit in the other questions. + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..5631fd1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,28 @@ +name: Feature request +description: Suggest an idea for this project +labels: enhancement + +body: + - type: markdown + attributes: + value: | + ## Please fill out the form below with as much information as possible. + - type: textarea + id: request + attributes: + label: Feature Request + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + id: solution + attributes: + label: Solution + description: Describe the solution you'd like + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Context + description: Provide any additional details that do not fit in the other questions. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..63d1fdf --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ + + +### PR Checklist + +* [ ] Have you verified that the code changes in the pull request are related to only the items you wish to change? +* [ ] Have you run the game locally and ensured the changes are working as expected? +* [ ] Have you ensured that there is not already a pull request or active feature for the one you are adding? + +### License Checklist + +* [ ] Confirm that you are ok with these changes being used for a commercial release of this game +* [ ] Confirm that you are agreeing that these changes will be licensed under the license shown in the LICENSE.md file diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml new file mode 100644 index 0000000..7ef7e30 --- /dev/null +++ b/.github/workflows/pr.yml @@ -0,0 +1,63 @@ +name: Build Pull Request + +on: pull_request + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup JDK + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + - name: Setup Android SDK + uses: android-actions/setup-android@v3 + - name: Setup wine + id: wine_install + run: | + sudo apt install wine64 + echo "WINE_PATH=$(which wine64)" >> $GITHUB_OUTPUT + - name: Save Android Debug Keystore + uses: akiojin/decode-base64-github-action@v0.1.0 + with: + base64: ${{ secrets.ANDROID_DEBUG_KEYSTORE }} + output-path: debug.keystore + - name: Setup Android Debug Keystore + run: | + echo "GODOT_ANDROID_KEYSTORE_DEBUG_PATH=debug.keystore" >> $GITHUB_ENV + echo "GODOT_ANDROID_KEYSTORE_DEBUG_USER=${{ secrets.ANDROID_DEBUG_KEYSTORE_USER }}" >> $GITHUB_ENV + echo "GODOT_ANDROID_KEYSTORE_DEBUG_PASSWORD=${{ secrets.ANDROID_DEBUG_KEYSTORE_PASSWORD }}" >> $GITHUB_ENV + - name: Export Game + id: export + uses: firebelley/godot-export@v5.2.0 + with: + godot_executable_download_url: https://downloads.tuxfamily.org/godotengine/4.2/Godot_v4.2-stable_linux.x86_64.zip + godot_export_templates_download_url: https://downloads.tuxfamily.org/godotengine/4.2/Godot_v4.2-stable_export_templates.tpz + relative_project_path: ./ + archive_output: true + export_debug: true + cache: true + wine_path: ${{ steps.wine_install.outputs.WINE_PATH }} + - name: Upload Linux Artifact + uses: actions/upload-artifact@v3 + with: + name: linux + path: ${{ steps.export.outputs.archive_directory }}/LinuxX11.zip + - name: Upload Web Artifact + uses: actions/upload-artifact@v3 + with: + name: web + path: ${{ steps.export.outputs.archive_directory }}/Web.zip + - name: Upload Windows Artifact + uses: actions/upload-artifact@v3 + with: + name: windows + path: ${{ steps.export.outputs.archive_directory }}/Windows Desktop.zip + - name: Upload Android Artifact + uses: actions/upload-artifact@v3 + with: + name: android + path: ${{ steps.export.outputs.archive_directory }}/Android.zip diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..25f041d --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,77 @@ +name: Release + +on: + push: + tags: + - 'v*' + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Setup JDK + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + - name: Setup Android SDK + uses: android-actions/setup-android@v3 + - name: Setup wine + id: wine_install + run: | + sudo apt install wine64 + echo "WINE_PATH=$(which wine64)" >> $GITHUB_OUTPUT + - name: Save Android Debug Keystore + uses: akiojin/decode-base64-github-action@v0.1.0 + with: + base64: ${{ secrets.ANDROID_DEBUG_KEYSTORE }} + output-path: debug.keystore + - name: Setup Android Debug Keystore + run: | + echo "GODOT_ANDROID_KEYSTORE_DEBUG_PATH=debug.keystore" >> $GITHUB_ENV + echo "GODOT_ANDROID_KEYSTORE_DEBUG_USER=${{ secrets.ANDROID_DEBUG_KEYSTORE_USER }}" >> $GITHUB_ENV + echo "GODOT_ANDROID_KEYSTORE_DEBUG_PASSWORD=${{ secrets.ANDROID_DEBUG_KEYSTORE_PASSWORD }}" >> $GITHUB_ENV + - name: Export Game + id: export + uses: firebelley/godot-export@v5.2.0 + with: + godot_executable_download_url: https://downloads.tuxfamily.org/godotengine/4.2/Godot_v4.2-stable_linux.x86_64.zip + godot_export_templates_download_url: https://downloads.tuxfamily.org/godotengine/4.2/Godot_v4.2-stable_export_templates.tpz + relative_project_path: ./ + archive_output: true + export_debug: true + cache: true + wine_path: ${{ steps.wine_install.outputs.WINE_PATH }} + - name: Create Release + uses: ncipollo/release-action@v1.13.0 + with: + token: ${{ secrets.GITHUB_TOKEN }} + generateReleaseNotes: true + tag: ${{ github.ref_name }} + artifacts: ${{ steps.export.outputs.archive_directory }}/* + - name: Setup Butler + shell: bash + run: | + curl -L -o butler.zip https://broth.itch.ovh/butler/linux-amd64/LATEST/archive/default + unzip butler.zip + chmod +x butler + ./butler -V + - name: Publish Linux + env: + BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }} + run: ./butler push ${{ steps.export.outputs.archive_directory }}/LinuxX11.zip d10sfan/cat-fish:linux --userversion ${{ github.ref_name }} + - name: Publish Web + env: + BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }} + run: ./butler push ${{ steps.export.outputs.archive_directory }}/Web.zip d10sfan/cat-fish:html5 --userversion ${{ github.ref_name }} + - name: Publish Windows + env: + BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }} + run: ./butler push ${{ steps.export.outputs.archive_directory }}/"Windows Desktop.zip" d10sfan/cat-fish:win --userversion ${{ github.ref_name }} + - name: Publish Android + env: + BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }} + run: ./butler push ${{ steps.export.outputs.archive_directory }}/Android.zip d10sfan/cat-fish:android --userversion ${{ github.ref_name }} + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..4e4fa78 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 d10sfan + +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 new file mode 100644 index 0000000..e88a3e4 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Cat Fish + +Fish clicking game made in Godot 4. https://d10sfan.itch.io/cat-fish + +## Development Information + +CI is setup to build artifacts for Linux, Windows, Web, and Android. The game is built with GDScript. Contributions, including code and assets, are welcome! Please look over the pull request template. As well, feature ideas or bugs found are also welcome to be reported. + +### Android + +A new debug keystore can be created with a command similar to the following + +```bash +keytool -keyalg RSA -genkeypair -alias androiddebugkey -keypass android -keystore debug.keystore -storepass android -dname "CN=Android Debug,O=Android,C=US" -validity 9999 -deststoretype pkcs12 +``` + +The keystore can then be converted to base64 and stored in the github secrets. + +## License Information + +License for the game can be seen here - https://github.com/d10sfan/cat-fish/blob/main/LICENSE.md + +For any assets used in the project, see the assets/assets_licenses folder. +