From 40a471fa4c7d43aae960f2408f9d8bed272578a7 Mon Sep 17 00:00:00 2001 From: Sherwin-14 Date: Mon, 22 Jul 2024 12:01:11 +0530 Subject: [PATCH 01/13] Added issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 73 +++++++++++++++++++ .github/ISSUE_TEMPLATE/community-support.yml | 2 + .github/ISSUE_TEMPLATE/config.yml | 1 + .../ISSUE_TEMPLATE/suggest-new-feature.yml | 3 + 4 files changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/community-support.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/suggest-new-feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..9431b3db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,73 @@ +name: 🐞 Bug +description: > + A bug is an issue that meets one of the following criteria: + - The behavior of the application differs from the documentation + - The documentation contains errors or omissions + - Other unexpected behavior +title: "[BUG] " +labels: ["Bug", "Needs Triage"] +body: +- type: checkboxes + attributes: + label: Is this issue already tracked somewhere, or is this a new report? + description: Check if a similar issue has already been reported before submitting a new one. + options: + - label: I've reviewed existing issues and couldn't find a duplicate for this problem. + required: true + +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false + +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 1. With this config... + 1. Run '...' + 1. See error... + validations: + required: false + +- type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Python**: 3.11.2 + value: | + - OS: + - Python: + render: markdown + validations: + required: false + +- type: textarea + attributes: + label: Additional Context + description: | + Any additional information that might be helpful in resolving this issue, such as: + - Error messages or stack traces + - Relevant configuration files or code snippets + + Tip: You can attach files or images by clicking this area to highlight it and then dragging files in. + validations: + required: false + + + + + diff --git a/.github/ISSUE_TEMPLATE/community-support.yml b/.github/ISSUE_TEMPLATE/community-support.yml new file mode 100644 index 00000000..099dfcfc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/community-support.yml @@ -0,0 +1,2 @@ +name : 🌟 Community Support +description : General questions, discussions, or topics that don't fit into a specific bug report or feature request. Not for reporting bugs or errors - use the Bug category for those.Need guidance on using a feature, clarifying a concept, or have general questions? [Visit our Q&A page](https://github.com/nsidc/earthaccess/discussions/categories/q-a) for community-driven support and discussion. Ideal for seeking help with implementation, understanding functionality, or resolving uncertainties. \ 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 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/suggest-new-feature.yml b/.github/ISSUE_TEMPLATE/suggest-new-feature.yml new file mode 100644 index 00000000..8237f065 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggest-new-feature.yml @@ -0,0 +1,3 @@ +name: 💡 Suggest a new feature +description: > + Have an idea for a new feature or enhancement? Share it with us! [Suggest a new feature](: https://github.com/nsidc/earthaccess/discussions/new?category=ideas) From f134c5f0e6c9ba290f7ba6ec2e27cb2581cce732 Mon Sep 17 00:00:00 2001 From: betolink <betolin@gmail.com> Date: Fri, 19 Jul 2024 14:40:31 -0500 Subject: [PATCH 02/13] allowing regexes in bump version --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 316a4ac7..5e1b4e46 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -158,6 +158,7 @@ combine-as-imports = true current_version = "0.9.0" commit = false tag = false +regex = true [[tool.bumpversion.files]] filename = "pyproject.toml" From ab3bfb0c4bb6534d6ad0b91b1894e8d434900136 Mon Sep 17 00:00:00 2001 From: betolink <betolin@gmail.com> Date: Fri, 19 Jul 2024 14:41:51 -0500 Subject: [PATCH 03/13] releasing v0.10.0 --- CHANGELOG.md | 2 +- CITATION.cff | 4 ++-- pyproject.toml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 882538ea..8e49ac4a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## Unreleased +## [v0.10.0] 2024-07-19 ### Changed diff --git a/CITATION.cff b/CITATION.cff index 9da253c3..28242edc 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -26,8 +26,8 @@ keywords: url: "https://earthaccess.readthedocs.io" repository-code: "https://github.com/nsidc/earthaccess" -version: "0.9.0" -date-released: "2024-02-28" +version: "0.10.0" +date-released: "2024-07-19" authors: - family-names: "Barrett" diff --git a/pyproject.toml b/pyproject.toml index 5e1b4e46..54f73e0f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "earthaccess" -version = "0.9.0" +version = "0.10.0" repository = "https://github.com/nsidc/earthaccess" documentation = "https://earthaccess.readthedocs.io" description = "Client library for NASA Earthdata APIs" @@ -155,7 +155,7 @@ convention = "google" combine-as-imports = true [tool.bumpversion] -current_version = "0.9.0" +current_version = "0.10.0" commit = false tag = false regex = true From 78adcd6e08ffc6c67440df083946b23c18b44ae4 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Thu, 25 Jul 2024 09:21:26 +0530 Subject: [PATCH 04/13] earthaccess-login.yml --- .github/workflows/main.yml | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 00000000..09a9370b --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,7 @@ +steps: + - name: Login to WB + env: + WB_USERNAME: ${{ secrets.WB_USERNAME }} + WB_PASSWORD: ${{ secrets.WB_PASSWORD }} + run: | + # Your login command or script here From 8338409dcefea5a47da889df01f2a898688158d0 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Thu, 25 Jul 2024 09:24:33 +0530 Subject: [PATCH 05/13] Update main.yml --- .github/workflows/main.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 09a9370b..04292592 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,7 +1,7 @@ -steps: - - name: Login to WB - env: - WB_USERNAME: ${{ secrets.WB_USERNAME }} - WB_PASSWORD: ${{ secrets.WB_PASSWORD }} - run: | - # Your login command or script here +- name: Test + env: + EDL_USERNAME: ${{ secrets.WB_USERNAME }} + EDL_PASSWORD: ${{ secrets.WB_PASSWORD }} + run: | + poetry run bash scripts/integration-test.sh + From 46b8b7079a3157cb6f507367ecc905f745673ff4 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Thu, 25 Jul 2024 09:32:49 +0530 Subject: [PATCH 06/13] Update main.yml --- .github/workflows/main.yml | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 04292592..46f98bf1 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -1,7 +1,15 @@ -- name: Test - env: - EDL_USERNAME: ${{ secrets.WB_USERNAME }} - EDL_PASSWORD: ${{ secrets.WB_PASSWORD }} - run: | - poetry run bash scripts/integration-test.sh +name: Test +on: + push: + branches: + - main + +jobs: + login: + runs-on: ubuntu-latest + steps: + - env: + EDL_USERNAME: ${{ secrets.EDL_USERNAME }} + EDL_PASSWORD: ${{ secrets.EDL_PASSWORD }} + run: poetry run bash scripts/integration-test.sh From 6e5a24d569a5a6aa7e082b0b7cb957e5450c9640 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Thu, 25 Jul 2024 09:43:13 +0530 Subject: [PATCH 07/13] Delete .github/workflows/main.yml --- .github/workflows/main.yml | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml deleted file mode 100644 index 46f98bf1..00000000 --- a/.github/workflows/main.yml +++ /dev/null @@ -1,15 +0,0 @@ -name: Test - -on: - push: - branches: - - main - -jobs: - login: - runs-on: ubuntu-latest - steps: - - env: - EDL_USERNAME: ${{ secrets.EDL_USERNAME }} - EDL_PASSWORD: ${{ secrets.EDL_PASSWORD }} - run: poetry run bash scripts/integration-test.sh From 4b99b8831a6fd75b17c889883574c59f5c1f8145 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Sat, 27 Jul 2024 16:05:24 +0530 Subject: [PATCH 08/13] Update bug.yml with certain changes --- .github/ISSUE_TEMPLATE/bug.yml | 113 ++++++++++++++++----------------- 1 file changed, 55 insertions(+), 58 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 9431b3db..c78e8c8d 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -4,70 +4,67 @@ description: > - The behavior of the application differs from the documentation - The documentation contains errors or omissions - Other unexpected behavior -title: "[BUG] <title>" -labels: ["Bug", "Needs Triage"] +title: "[BUG] {{ title }}" +labels: + - Bug + - Needs Triage body: -- type: checkboxes - attributes: - label: Is this issue already tracked somewhere, or is this a new report? - description: Check if a similar issue has already been reported before submitting a new one. - options: - - label: I've reviewed existing issues and couldn't find a duplicate for this problem. - required: true + - type: checkboxes + attributes: + label: Is this issue already tracked somewhere, or is this a new report? + description: Check if a similar issue has already been reported before submitting a new one. + options: + - label: I've reviewed existing issues and couldn't find a duplicate for this problem. + required: true -- type: textarea - attributes: - label: Current Behavior - description: A concise description of what you're experiencing. - validations: - required: false + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true -- type: textarea - attributes: - label: Expected Behavior - description: A concise description of what you expected to happen. - validations: - required: false + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true -- type: textarea - attributes: - label: Steps To Reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. In this environment... - 1. With this config... - 1. Run '...' - 1. See error... - validations: - required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true -- type: textarea - attributes: - label: Environment - description: | - examples: + - type: textarea + attributes: + label: Environment + description: | + Examples: - **OS**: Ubuntu 20.04 - **Python**: 3.11.2 - value: | - - OS: - - Python: - render: markdown - validations: - required: false - -- type: textarea - attributes: - label: Additional Context - description: | - Any additional information that might be helpful in resolving this issue, such as: - - Error messages or stack traces - - Relevant configuration files or code snippets - - Tip: You can attach files or images by clicking this area to highlight it and then dragging files in. - validations: - required: false - - + value: | + - OS: + - Python: + render: markdown + validations: + required: true - + - type: textarea + attributes: + label: Additional Context + description: | + Any additional information that might be helpful in resolving this issue, such as: + - Error messages or stack traces + - Relevant configuration files or code snippets + Tip: You can attach files or images by clicking this area to highlight it and then dragging files in. + validations: + required: false From a34301908f6da99d4d03108c785bfc1ac67cd781 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Sat, 27 Jul 2024 16:12:57 +0530 Subject: [PATCH 09/13] Updated description bug.yml --- .github/ISSUE_TEMPLATE/bug.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index c78e8c8d..3f4e544e 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,9 +1,6 @@ name: 🐞 Bug description: > - A bug is an issue that meets one of the following criteria: - - The behavior of the application differs from the documentation - - The documentation contains errors or omissions - - Other unexpected behavior + A bug is an issue that differs from documentation or has unexpected behavior. title: "[BUG] {{ title }}" labels: - Bug From 892e878108f9e605fc46efb896231945e7ca38f5 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Sat, 27 Jul 2024 16:17:12 +0530 Subject: [PATCH 10/13] Updated community support with body community-support.yml --- .github/ISSUE_TEMPLATE/community-support.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/community-support.yml b/.github/ISSUE_TEMPLATE/community-support.yml index 099dfcfc..2756080c 100644 --- a/.github/ISSUE_TEMPLATE/community-support.yml +++ b/.github/ISSUE_TEMPLATE/community-support.yml @@ -1,2 +1,7 @@ -name : 🌟 Community Support -description : General questions, discussions, or topics that don't fit into a specific bug report or feature request. Not for reporting bugs or errors - use the Bug category for those.Need guidance on using a feature, clarifying a concept, or have general questions? [Visit our Q&A page](https://github.com/nsidc/earthaccess/discussions/categories/q-a) for community-driven support and discussion. Ideal for seeking help with implementation, understanding functionality, or resolving uncertainties. \ No newline at end of file +name: 🌟 Community Support +description: General questions, discussions, or topics that don't fit into a specific bug report or feature request. Not for reporting bugs or errors - use the Bug category for those.Need guidance on using a feature, clarifying a concept, or have general questions? +body: + - type: markdown + attributes: + value: | + For community-driven support and discussion, please visit our [Q&A page](https://github.com/nsidc/earthaccess/discussions/categories/q-a). From 38181b00c9530d84be7316c0af4737fc5850651f Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Sat, 27 Jul 2024 16:18:30 +0530 Subject: [PATCH 11/13] Updated the file non markdown entry community-support.yml --- .github/ISSUE_TEMPLATE/community-support.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/community-support.yml b/.github/ISSUE_TEMPLATE/community-support.yml index 2756080c..33d53dba 100644 --- a/.github/ISSUE_TEMPLATE/community-support.yml +++ b/.github/ISSUE_TEMPLATE/community-support.yml @@ -5,3 +5,8 @@ body: attributes: value: | For community-driven support and discussion, please visit our [Q&A page](https://github.com/nsidc/earthaccess/discussions/categories/q-a). + - type: textarea + attributes: + label: Describe your question or topic + description: Please provide as much detail as possible + placeholder: Start typing... From 3f335925a17c02adf5fc68b1bd9c22250d312013 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Sat, 27 Jul 2024 16:20:24 +0530 Subject: [PATCH 12/13] Updated description to fit to character limit community-support.yml --- .github/ISSUE_TEMPLATE/community-support.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/community-support.yml b/.github/ISSUE_TEMPLATE/community-support.yml index 33d53dba..06959cdf 100644 --- a/.github/ISSUE_TEMPLATE/community-support.yml +++ b/.github/ISSUE_TEMPLATE/community-support.yml @@ -1,5 +1,5 @@ name: 🌟 Community Support -description: General questions, discussions, or topics that don't fit into a specific bug report or feature request. Not for reporting bugs or errors - use the Bug category for those.Need guidance on using a feature, clarifying a concept, or have general questions? +description: General questions, discussions, or topics. Not for bugs/errors (use Bug category). Need guidance on features, concepts, or have questions? body: - type: markdown attributes: From 73becc8ad1cdac0e83f06401476df10517fb3ccd Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Sat, 27 Jul 2024 16:22:26 +0530 Subject: [PATCH 13/13] Updated suggest-new-feature.yml --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++-- .github/ISSUE_TEMPLATE/suggest-new-feature.yml | 13 +++++++++++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 3f4e544e..8f94d0c4 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -48,8 +48,8 @@ body: - **OS**: Ubuntu 20.04 - **Python**: 3.11.2 value: | - - OS: - - Python: + - OS: + - Python: render: markdown validations: required: true diff --git a/.github/ISSUE_TEMPLATE/suggest-new-feature.yml b/.github/ISSUE_TEMPLATE/suggest-new-feature.yml index 8237f065..40426fa6 100644 --- a/.github/ISSUE_TEMPLATE/suggest-new-feature.yml +++ b/.github/ISSUE_TEMPLATE/suggest-new-feature.yml @@ -1,3 +1,12 @@ name: 💡 Suggest a new feature -description: > - Have an idea for a new feature or enhancement? Share it with us! [Suggest a new feature](: https://github.com/nsidc/earthaccess/discussions/new?category=ideas) +description: Have an idea for a new feature or enhancement? Share it with us! +body: + - type: markdown + attributes: + value: | + To suggest a new feature, please visit our [Ideas discussion board](https://github.com/nsidc/earthaccess/discussions/new?category=ideas) and share your idea with us! + - type: textarea + attributes: + label: Describe your idea + description: Please provide as much detail as possible + placeholder: Start typing...