From ca0d7e1ea279bb46c1247af73640fdae02026c48 Mon Sep 17 00:00:00 2001 From: Hayden <64056131+hay-kot@users.noreply.github.com> Date: Mon, 23 May 2022 21:53:54 -0800 Subject: [PATCH] chore: github chores (#1267) * grab `dev` branch templates * add beta-release workflow --- .github/ISSUE_TEMPLATE/bug-report.yaml | 54 ++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 38 ------------ .github/ISSUE_TEMPLATE/v1-bug-report.yaml | 47 ++++++++++++++ .github/ISSUE_TEMPLATE/v1-task.yaml | 38 ++++++++++++ .github/workflows/beta-release.yml | 75 +++++++++++++++++++++++ .github/workflows/build-docs.yml | 20 ------ 6 files changed, 214 insertions(+), 58 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/v1-bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/v1-task.yaml create mode 100644 .github/workflows/beta-release.yml delete mode 100644 .github/workflows/build-docs.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 0000000000..456d5b7b3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,54 @@ +--- +name: "[v0.5.x] Bug Report" +description: "submit a bug report for the current release" +body: + - type: checkboxes + id: checks + attributes: + label: First Check + description: Please confirm and check all the following options. + options: + - label: This is not a feature request + required: true + - label: I added a very descriptive title to this issue. + required: true + - label: I used the GitHub search to find a similar issue and didn't find it. + required: true + - label: I searched the Mealie documentation, with the integrated search. + required: true + - label: I already read the docs and didn't find an answer. + required: true + - label: I have checked for existing issues that have been resolved in v1-beta + required: true + - type: textarea + id: description + attributes: + label: What is the issue you are experiencing? + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: dropdown + id: os + attributes: + label: Deployment + description: What Deployment system are you using? + multiple: true + options: + - Docker (Linux) + - Docker (Windows) + - Docker (Synology) + - Unraid + - Other + validations: + required: true + - type: textarea + id: os-details + attributes: + label: Deployment Details + description: You can add more details about your operating system here, in particular if you chose "Other". If you are experiencing issues with deployment, please provide your docker-compose or docker commands + - type: input + id: mealie-version + attributes: + label: Mealie Version + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd28c34e9f..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug Report -about: Create a bug report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** - - -**Steps To Reproduce** -Please be specific! -1. Go to '...' -2. Click on '....' -3. etc. - -**Sample Code** - - -**Expected behavior** - - -**Actual Behavior** - - -**Screenshots** - - -**Device Information (please complete the following information):** - - OS: [e.g., WSL2 on Win10, Mac] - - Deployment: [e.g., Docker-version, docker-compose, Python application] - - Browser: [e.g., chrome, safari] - - Version: [e.g., 0.2.0-dev] - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/v1-bug-report.yaml b/.github/ISSUE_TEMPLATE/v1-bug-report.yaml new file mode 100644 index 0000000000..3a4c490bc4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/v1-bug-report.yaml @@ -0,0 +1,47 @@ +--- +name: v1.0.0b Bug Report +description: "submit a bug report for the v1 beta" +title: "[v1.0.0b] - YOUR TITLE" +body: + - type: checkboxes + id: checks + attributes: + label: First Check + description: Please confirm and check all the following options. + options: + - label: This is not a feature request + required: true + - label: I added a very descriptive title to this issue. + required: true + - label: I used the GitHub search to find a similar issue and didn't find it. + required: true + - label: I searched the Mealie documentation, with the integrated search. + required: true + - label: I already read the docs and didn't find an answer. + required: true + - type: textarea + id: description + attributes: + label: What is the issue you are experiencing? + placeholder: A clear and concise description of what the bug is. + validations: + required: true + - type: dropdown + id: os + attributes: + label: Deployment + description: What Deployment system are you using? + multiple: true + options: + - Docker (Linux) + - Docker (Windows) + - Docker (Synology) + - Unraid + - Other + validations: + required: true + - type: textarea + id: os-details + attributes: + label: Deployment Details + description: You can add more details about your operating system here, in particular if you chose "Other". If you are experiencing issues with deployment, please provide your docker-compose or docker commands diff --git a/.github/ISSUE_TEMPLATE/v1-task.yaml b/.github/ISSUE_TEMPLATE/v1-task.yaml new file mode 100644 index 0000000000..87e0c8b359 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/v1-task.yaml @@ -0,0 +1,38 @@ +--- +name: v1.0.0b Task +description: "CONTRIBUTORS ONLY: Submit a Task that needs to be completed" +title: "[v1.0.0b] [Task] - TASK DESCRIPTION" +labels: + - task + - v1 +body: + - type: markdown + attributes: + value: | + Thanks for your interest in Mealie! 🚀 + + This is a place for Mealie contributors to find tasks that need to get done around the repository. Tasks are different than issues as they are generally related to providing a new feature or improve an existing feature. They are _generally_ not related to an issue. + + **DO NOT** create a task unless + - You are a contributors who has prior approval via discord/discussions + - You have otherwise been given approval to post the tasks + + Otherwise, your post will be closed/deleted. + + **Interested in Taking This?** + + If you're interested in completing this tasks and it hasn't already been taken, comment below and to let others know you're working on it. As you work through the task, I ask that you submit a draft pull request as soon as possible, and tag this issue so we can all collaborate as best as possible. + - type: textarea + id: problem + attributes: + label: What is the problem this task addresses? + placeholder: A clear and concise description of what the problem this task will address. + validations: + required: true + - type: textarea + id: solution + attributes: + label: Proposed/Possible Solution(s)? + placeholder: Provide as much context around the idea as possible with potential files and roadblocks that may come up + validations: + required: true diff --git a/.github/workflows/beta-release.yml b/.github/workflows/beta-release.yml new file mode 100644 index 0000000000..a5b473c95c --- /dev/null +++ b/.github/workflows/beta-release.yml @@ -0,0 +1,75 @@ +name: Docker Build Production + +on: + release: + types: [published] + +jobs: + build: + runs-on: ubuntu-latest + steps: + # + # Get Release Version + # + - uses: oprypin/find-latest-tag@v1 + with: + repository: hay-kot/mealie # The repository to scan. + releases-only: true # We know that all relevant tags have a GitHub release for them. + id: mealie_version # The step ID to refer to later. + # + # Checkout + # + - name: checkout code + uses: actions/checkout@v2 + # + # Setup QEMU + # + - name: Set up QEMU + id: qemu + uses: docker/setup-qemu-action@v1 + with: + image: tonistiigi/binfmt:latest + platforms: all + # + # Setup Buildx + # + - name: install buildx + id: buildx + uses: docker/setup-buildx-action@v1 + with: + install: true + # + # Login to Docker Hub + # + - name: Login to Docker Hub + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + # + # Build Backend + # + - name: build the image + run: | + docker build --push --no-cache \ + --tag hkotel/mealie:api-${{ steps.mealie_version.outputs.tag }} \ + --build-arg COMMIT=$(git rev-parse HEAD) \ + --platform linux/amd64,linux/arm64 . + # + # Build Frontend + # + - name: build the image + working-directory: "frontend" + run: | + docker build --push --no-cache \ + --tag hkotel/mealie:frontend-${{ steps.mealie_version.outputs.tag }} \ + --platform linux/amd64,linux/arm64 . + # + # Release Discord Notification + # + - name: Discord notification + env: + DISCORD_WEBHOOK: ${{ secrets.DISCORD_RELEASE_WEBHOOK }} + uses: Ilshidur/action-discord@0.3.2 + with: + args: '🚀 Version {{ EVENT_PAYLOAD.release.tag_name }} of Mealie has been released. See the release notes https://github.com/hay-kot/mealie/releases/tag/{{ EVENT_PAYLOAD.release.tag_name }}' diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml deleted file mode 100644 index 3712b2cff2..0000000000 --- a/.github/workflows/build-docs.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: Publish docs via GitHub Pages -on: - push: - branches: - - master - -jobs: - build: - name: Deploy docs - runs-on: ubuntu-latest - steps: - - name: Checkout main - uses: actions/checkout@v1 - - - name: Deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - CONFIG_FILE: docs/mkdocs.yml - EXTRA_PACKAGES: build-base