From c4ecd9ab36d207fda2bff5b862e920857190c261 Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Wed, 18 Dec 2024 13:03:04 -0800 Subject: [PATCH] Fix coverage workflow and update GH templates (#250) --- .github/ISSUE_TEMPLATE/bug_report.yml | 35 +++++++--------------- .github/ISSUE_TEMPLATE/documentation.yml | 20 +++++-------- .github/ISSUE_TEMPLATE/feature_request.yml | 18 +++++------ .github/pull_request_template.md | 10 +++---- .github/workflows/HDMF_dev.yaml | 2 ++ .github/workflows/deploy_release.yml | 2 ++ .github/workflows/run_all_tests.yml | 6 ++++ .github/workflows/run_coverage.yml | 4 ++- .github/workflows/run_tests.yml | 8 +++++ 9 files changed, 51 insertions(+), 54 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 5f5b3171..d0c7be9f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -48,25 +48,16 @@ body: - Linux validations: required: true - - type: dropdown - id: executable - attributes: - label: Python Executable - options: - - Conda - - Python - validations: - required: true - type: dropdown id: python_version attributes: label: Python Version options: - - "3.9" - - "3.10" - - "3.11" - - "3.12" - "3.13" + - "3.12" + - "3.11" + - "3.10" + - "3.9" validations: required: true - type: textarea @@ -80,15 +71,11 @@ body: You can attach images or log files by clicking this area to highlight it and then dragging files in. If GitHub upload is not working, you can also copy and paste the output into this section. - - type: checkboxes - id: terms + - type: markdown attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md) - options: - - label: I agree to follow this project's [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md) - required: true - - label: Have you checked the [Contributing](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst) document? - required: true - - label: Have you ensured this bug was not already [reported](https://github.com/hdmf-dev/hdmf-zarr/issues)? - required: true + value: | + By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md). + + Before submitting this issue, please review the [Contributing Guide](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst). + + Please also ensure that this issue has not already been [reported](https://github.com/hdmf-dev/hdmf-zarr/issues). Thank you! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 1558a13e..57a05312 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -1,7 +1,7 @@ name: Documentation description: Is the documentation of something missing, unclear, or lacking? This is the place. title: "[Documentation]: " -labels: "documentation" +labels: ["documentation"] body: - type: markdown attributes: @@ -32,15 +32,11 @@ body: - No. validations: required: true - - type: checkboxes - id: terms + - type: markdown attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md) - options: - - label: I agree to follow this project's [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md) - required: true - - label: Have you checked the [Contributing](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst) document? - required: true - - label: Have you ensured this change was not already [requested](https://github.com/hdmf-dev/hdmf-zarr/issues)? - required: true + value: | + By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md). + + Before submitting this issue, please review the [Contributing Guide](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst). + + Please also ensure that this issue has not already been [reported](https://github.com/hdmf-dev/hdmf-zarr/issues). Thank you! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 85462b52..d7a3bbf8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -50,15 +50,11 @@ body: - No. validations: required: true - - type: checkboxes - id: terms + - type: markdown attributes: - label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md) - options: - - label: I agree to follow this project's [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md) - required: true - - label: Have you checked the [Contributing](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst) document? - required: true - - label: Have you ensured this change was not already [requested](https://github.com/hdmf-dev/hdmf-zarr/issues)? - required: true + value: | + By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/.github/CODE_OF_CONDUCT.md). + + Before submitting this issue, please review the [Contributing Guide](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst). + + Please also ensure that this issue has not already been [reported](https://github.com/hdmf-dev/hdmf-zarr/issues). Thank you! diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8435ea82..ffce4c93 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,9 +9,7 @@ Show how to reproduce the new behavior (can be a bug fix or a new feature) ## Checklist -- [ ] Did you update CHANGELOG.md with your changes? -- [ ] Have you checked our [Contributing](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst) document? -- [ ] Have you ensured the PR clearly describes the problem and the solution? -- [ ] Is your contribution compliant with our coding style? This can be checked running `ruff` from the source directory. -- [ ] Have you checked to ensure that there aren't other open [Pull Requests](https://github.com/hdmf-dev/hdmf-zarr/pulls) for the same change? -- [ ] Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged. +- [ ] Did you update `CHANGELOG.md` with your changes? +- [ ] Does the PR clearly describe the problem and the solution? +- [ ] Have you reviewed our [Contributing Guide](https://github.com/hdmf-dev/hdmf-zarr/blob/dev/docs/CONTRIBUTING.rst)? +- [ ] Does the PR use "Fix #XXX" notation to tell GitHub to close the relevant issue numbered XXX when the PR is merged? \ No newline at end of file diff --git a/.github/workflows/HDMF_dev.yaml b/.github/workflows/HDMF_dev.yaml index 4500b792..1ecc4fde 100644 --- a/.github/workflows/HDMF_dev.yaml +++ b/.github/workflows/HDMF_dev.yaml @@ -11,6 +11,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5 diff --git a/.github/workflows/deploy_release.yml b/.github/workflows/deploy_release.yml index bffde629..aeffa18e 100644 --- a/.github/workflows/deploy_release.yml +++ b/.github/workflows/deploy_release.yml @@ -11,6 +11,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5 diff --git a/.github/workflows/run_all_tests.yml b/.github/workflows/run_all_tests.yml index 13a38d2b..129cdad8 100644 --- a/.github/workflows/run_all_tests.yml +++ b/.github/workflows/run_all_tests.yml @@ -49,6 +49,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5 @@ -103,6 +105,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5 @@ -142,6 +146,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Conda uses: conda-incubator/setup-miniconda@v3 diff --git a/.github/workflows/run_coverage.yml b/.github/workflows/run_coverage.yml index 20011920..260c8004 100644 --- a/.github/workflows/run_coverage.yml +++ b/.github/workflows/run_coverage.yml @@ -35,6 +35,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5 @@ -46,7 +48,7 @@ jobs: python -m pip install --upgrade pip - name: Install package - if: ! ${{ matrix.opt_req }} + if: ${{ ! matrix.opt_req }} run: | python -m pip install ".[test]" diff --git a/.github/workflows/run_tests.yml b/.github/workflows/run_tests.yml index 521995c1..0fd692c5 100644 --- a/.github/workflows/run_tests.yml +++ b/.github/workflows/run_tests.yml @@ -35,6 +35,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5 @@ -91,6 +93,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5 @@ -126,6 +130,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Conda uses: conda-incubator/setup-miniconda@v3 @@ -175,6 +181,8 @@ jobs: steps: - name: Checkout repo uses: actions/checkout@v4 + with: + fetch-depth: 0 # tags are required to determine the version - name: Set up Python uses: actions/setup-python@v5