From 73b6609c51f9fd181b8504273e014da4b99f2ed2 Mon Sep 17 00:00:00 2001 From: Nightenom <17338378+Nightenom@users.noreply.github.com> Date: Tue, 27 Aug 2024 10:05:33 +0200 Subject: [PATCH] .github update, actions, cla (#99) --- .github/CONTRIBUTING | 3 + .github/ISSUE_TEMPLATE/10-bug-report.yaml | 83 +++++++++++++++++++ .../ISSUE_TEMPLATE/30-feature-request.yaml | 72 ++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 12 +++ .github/PULL_REQUEST_TEMPLATE | 12 +++ .github/workflows/build.yaml | 31 +++---- .github/workflows/release.yml | 19 ++--- README.md | 1 + 8 files changed, 206 insertions(+), 27 deletions(-) create mode 100644 .github/CONTRIBUTING create mode 100644 .github/ISSUE_TEMPLATE/10-bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/30-feature-request.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE diff --git a/.github/CONTRIBUTING b/.github/CONTRIBUTING new file mode 100644 index 0000000..a6108e7 --- /dev/null +++ b/.github/CONTRIBUTING @@ -0,0 +1,3 @@ +Please create an issue before submitting a pull request. + +All pull request authors need to sign our CLA: https://cla-assistant.io/Minecolonies/minecolonies diff --git a/.github/ISSUE_TEMPLATE/10-bug-report.yaml b/.github/ISSUE_TEMPLATE/10-bug-report.yaml new file mode 100644 index 0000000..f46cdcf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10-bug-report.yaml @@ -0,0 +1,83 @@ +name: Bug Report +description: If you have a reproducible in-game issue +labels: ["Bug"] +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues. + required: true + - type: checkboxes + attributes: + label: Are you using the latest BlockUI Version? + description: | + Please check to see if any newer version fixes the issue you're experiencing. + [List of all BlockUI versions](https://www.curseforge.com/minecraft/mc-mods/blockui/files/all) + [List of all Structurize versions](https://www.curseforge.com/minecraft/mc-mods/structurize/files/all) + [List of all MineColonies versions](https://www.curseforge.com/minecraft/mc-mods/minecolonies/files/all) + options: + - label: | + I am running the latest **beta/release** version of BlockUI for my Minecraft version. + I am also running the latest versions of other mods that are part of my problem. + required: true + - type: dropdown + id: mc_version + attributes: + label: Minecraft Version + options: ["1.20", "1.21"] + validations: + required: true + - type: input + attributes: + label: BlockUI Version + description: Exact BlockUI version either from file name or in-game mod list. + placeholder: 1.xx.xx-XXXX + validations: + required: true + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. Please provide screenshots and videos if possible. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Reproduction Steps + description: What should we do to make this issue show up in our own game? Try to give as much detail as possible here too so it's easier for us to reproduce this issue. + placeholder: | + 1. Do this... + 2. then this.... + 3. So that this happens + validations: + required: true + - type: input + attributes: + label: Logs + description: Please provide your latest.log related to the time during which you experienced the issue. Upload to eg. [gist](https://gist.github.com/) or [pastebin](https://pastebin.com/) and paste the link here. + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + Tip: You can attach images or log files by clicking any text area to highlight it and then dragging files in. + - type: textarea + attributes: + label: "Footer" + description: This is issue footer. Please leave this text as is. + value: | + --- + ## Viewers + * Add a thumbs-up to the bug report if you are also affected. This helps the bug report become more visible to the team and doesn't clutter the comments. + * Add a comment if you have any insights or background information that isn't already part of the conversation. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/30-feature-request.yaml b/.github/ISSUE_TEMPLATE/30-feature-request.yaml new file mode 100644 index 0000000..dc1f5d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/30-feature-request.yaml @@ -0,0 +1,72 @@ +name: Feature Request +description: If you have something new you would like to add +labels: ["Feature: Request"] +body: + - type: checkboxes + attributes: + label: Is there an existing feature request for this? + description: Please search to see if an issue already exists for your feature request. + options: + - label: I have searched the existing feature requests. + required: true + - type: checkboxes + attributes: + label: Are you using the latest BlockUI Version? + description: | + Please check to see if any newer version fixes the issue you're experiencing. + [List of all BlockUI versions](https://www.curseforge.com/minecraft/mc-mods/blockui/files/all) + [List of all Structurize versions](https://www.curseforge.com/minecraft/mc-mods/structurize/files/all) + [List of all MineColonies versions](https://www.curseforge.com/minecraft/mc-mods/minecolonies/files/all) + options: + - label: | + I am running the latest **beta/release** version of BlockUI for my Minecraft version. + I am also running the latest versions of other mods that are part of my problem. + required: true + - type: dropdown + id: mc_version + attributes: + label: Minecraft Version + options: ["1.20", "1.21"] + validations: + required: true + - type: input + attributes: + label: BlockUI Version + description: Exact BlockUI version either from file name or in-game mod list. + placeholder: 1.xx.xx-XXXX + - type: textarea + attributes: + label: Related Mods and their Versions + description: Mods that may (even indirectly, like Opfitine) interact. + placeholder: | + 1. Forge Version: + 2. BlockUI Version: + 3. Domum Ornamentum Version: + 4. .... + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: "A clear and concise description of what the problem is. Ex: I'm always frustrated when..." + - type: textarea + attributes: + label: Feature description + description: "A clear and concise description of what you want to happen." + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + Tip: You can attach images or log files by clicking any text area to highlight it and then dragging files in. + - type: textarea + attributes: + label: "Footer" + description: This is issue footer. Please leave this text as is. + value: | + --- + ## Viewers + * Add a thumbs-up to the bug report if you are also affected. This helps the bug report become more visible to the team and doesn't clutter the comments. + * Add a comment if you have any insights or background information that isn't already part of the conversation. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3c497f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +blank_issues_enabled: false +contact_links: + - name: Support Requests and Anything Else + about: Visit our discord + url: https://discord.minecolonies.com + - name: MineColonies Bug Tracker + about: Please follow the given template + url: https://github.com/ldtteam/minecolonies/issues/new/choose + - name: Structurize Bug Tracker + about: Please follow the given template + url: https://github.com/ldtteam/structurize/issues/new/choose + diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 0000000..2aeed96 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,12 @@ +Closes # +Closes # + +# Changes proposed in this pull request +- +- + +## Testing +- [ ] Yes I tested this before submitting it. +- [ ] I also did a multiplayer test. + +Review please diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index e44ea7e..29611d2 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -1,30 +1,33 @@ -name: Build and Test PRs or General Branches +name: Build and Pre-release on: pull_request: types: - - synchronize - opened - - ready_for_review - - reopened + - synchronize + - labeled + - unlabeled push: branches: - - 'feature/**' - - 'bugfix/**' - - 'hotfix/**' - - 'fix/**' - - 'features/**' + - "version/*" + - "release/*" + - "testing/*" workflow_dispatch: permissions: - contents: write + contents: read statuses: write + packages: write jobs: - release: + build: uses: ldtteam/operapublicacreator/.github/workflows/gradle.build.yaml@ng7 with: java: 21 - secrets: - CROWDIN_API_KEY: ${{ secrets.CROWDIN_API_KEY }} - GRADLE_ENCRYPTION_KEY: ${{ secrets.GRADLE_ENCRYPTION_KEY }} \ No newline at end of file + secrets: inherit + pre-release: + uses: ldtteam/operapublicacreator/.github/workflows/gradle.prerelease.yaml@ng7 + if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && contains( github.event.pull_request.labels.*.name, 'Pre-release') + with: + java: 21 + secrets: inherit \ No newline at end of file diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 4c5b568..7235e11 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,11 +2,10 @@ name: Release on: push: - branches: [ - "version/*", - "release/*", - "testing/*", - ] + branches: + - "version/*" + - "release/*" + - "testing/*" permissions: contents: write @@ -14,14 +13,8 @@ permissions: jobs: release: - uses: ldtteam/operapublicacreator/.github/workflows/gradle.publish.yaml@ng7 + uses: ldtteam/operapublicacreator/.github/workflows/gradle.release.yaml@ng7 with: java: 21 curse_release_type: ${{ contains(github.ref, 'release') && 'release' || 'beta' }} - secrets: - DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }} - MAVEN_USER: ${{ secrets.MAVEN_USER }} - MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }} - CROWDIN_API_KEY: ${{ secrets.CROWDIN_API_KEY }} - CURSE_API_KEY: ${{ secrets.CURSE_API_KEY }} - GRADLE_ENCRYPTION_KEY: ${{ secrets.GRADLE_ENCRYPTION_KEY }} \ No newline at end of file + secrets: inherit \ No newline at end of file diff --git a/README.md b/README.md index 067a322..b207d98 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![BlockUI CurseForge](https://img.shields.io/curseforge/dt/522992?logo=curseforge&color=F16436&label=BlockUI)](https://www.curseforge.com/minecraft/mc-mods/blockui) [![Release 1.20.1](https://img.shields.io/github/actions/workflow/status/ldtteam/blockui/release.yml?branch=version%2F1.20.1&label=Build%201.20.1&event=push)](https://github.com/ldtteam/BlockUI/actions/workflows/release.yml?query=branch%3Aversion%2F1.20.1+event%3Apush) [![Release 1.21.1](https://img.shields.io/github/actions/workflow/status/ldtteam/blockui/release.yml?branch=version%2Fmain&label=Build%201.21.1&event=push)](https://github.com/ldtteam/BlockUI/actions/workflows/release.yml?query=branch%3Aversion%2Fmain+event%3Apush) +[![CLA assistant](https://cla-assistant.io/readme/badge/ldtteam/BlockUI)](https://cla-assistant.io/ldtteam/BlockUI) ### BlockUI