Housekeeping

.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: github
+# repo_token: YOURTOKENHERE

.cruft.json

@@ -0,0 +1,28 @@
+{
+  "template": "https://github.com/Ouranosinc/cookiecutter-pypackage",
+  "commit": "49c15f3ab0a7aff9ccb2019abb117b226444dacb",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "full_name": "Thomas-Charles Fortier Filion",
+      "email": "tcff_hydro@outlook.com",
+      "github_username": "TC-FF",
+      "project_name": "xHydro",
+      "project_slug": "xhydro",
+      "project_short_description": "Hydrological analysis library built with xarray",
+      "pypi_username": "TC-FF",
+      "version": "0.1.3",
+      "use_pytest": "y",
+      "use_black": "y",
+      "use_pypi_deployment_with_travis": "n",
+      "add_pyup_badge": "n",
+      "make_docs": "y",
+      "command_line_interface": "No command-line interface",
+      "create_author_file": "y",
+      "open_source_license": "Apache-2.0",
+      "generated_with_cruft": "y",
+      "_template": "https://github.com/Ouranosinc/cookiecutter-pypackage"
+    }
+  },
+  "directory": null
+}

.editorconfig

@@ -10,6 +10,9 @@ insert_final_newline = true
 charset = utf-8
 end_of_line = lf
 
+[*.{yaml,yml}]
+indent_size = 2
+
 [*.bat]
 indent_style = tab
 end_of_line = crlf

.github/ISSUE_TEMPLATE/0001-GENERIC-ISSUE-TEMPLATE.yml

@@ -0,0 +1,34 @@
+name: Generic issue template
+description: For detailing generic/uncategorized issues in xHydro
+
+body:
+  - type: textarea
+    id: generic-issue
+    attributes:
+      label: Generic Issue
+      description: Please fill in the following information fields as needed.
+      value: |
+        * xhydro version:
+        * Python version:
+        * Operating System:
+
+        ### Description
+        <!--Describe what you were trying to get done.
+        Tell us what happened, what went wrong, and what you expected to happen.-->
+
+        ### What I Did
+        <!--Paste the command(s) you ran and the output.
+        If there was a crash, please include the traceback below.-->
+        ```
+        $ pip install foo --bar
+        ```
+
+        ### What I Received
+        <!--Paste the output or the stack trace of the problem you experienced here.-->
+        ```
+        Traceback (most recent call last):
+         File "/path/to/file/script.py", line 3326, in run_code
+           exec(code_obj, self.user_global_ns, self.user_ns)
+         File "<ipython-input-2-9e1622b385b6>", line 1, in <module>
+           1/0
+         ZeroDivisionError: division by zero

.github/ISSUE_TEMPLATE/0002-BUG-REPORT.yml

@@ -0,0 +1,44 @@
+name: Bug report
+description: Help us improve xHydro
+labels: [ "bug" ]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: setup-information
+    attributes:
+      label: Setup Information
+      description: |
+        What software versions are you running? Example:
+        - xhydro version: 0.55.0-gamma
+        - Python version: 4.2
+        - Operating System: Nutmeg Linux 12.34 | macOS 11.0 "Redmond"
+      value: |
+        - xhydro version:
+        - Python version:
+        - Operating System:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen.
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps To Reproduce
+      description: Paste the command(s) you ran and the output. If there was a crash, please include the traceback below.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+  - type: checkboxes
+    id: submit-pr
+    attributes:
+      label: Contribution
+      description: Do you intend to submit a fix for this bug? (The xHydro developers will help with code compliance)
+      options:
+        - label: I would be willing/able to open a Pull Request to address this bug.

.github/ISSUE_TEMPLATE/0003-FEATURE-REQUEST.yml

@@ -0,0 +1,31 @@
+name: Feature request
+description: Suggest an idea for xHydro
+labels: [ "enhancement" ]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: problem
+    attributes:
+      label: Addressing a Problem?
+      description: Is your feature request related to a problem? Please describe it.
+  - type: textarea
+    id: potential-solution
+    attributes:
+      label: Potential Solution
+      description: Describe the solution you'd like to see implemented.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context about the feature request here.
+  - type: checkboxes
+    id: submit-pr
+    attributes:
+      label: Contribution
+      description: Do you intend to submit a fix for this bug? (The xHydro developers will help with code compliance)
+      options:
+        - label: I would be willing/able to open a Pull Request to contribute this feature.

.github/ISSUE_TEMPLATE/0004-QUESTION-SUPPORT.yml

@@ -0,0 +1,23 @@
+name: Question/Support
+description: Ask for help from the developers
+labels: [ "support" ]
+
+body:
+  - type: textarea
+    id: setup-information
+    attributes:
+      label: Setup Information
+      description: |
+        What software versions are you running? Example:
+        - xhydro version: 0.55.0-gamma
+        - Python version: 4.2
+        - Operating System: Nutmeg Linux 12.34 | macOS 11.0 "Redmond"
+      value: |
+        - xhydro version:
+        - Python version:
+        - Operating System:
+  - type: textarea
+    id: description
+    attributes:
+      label: Context
+      description: Describe what you were trying to get done. Tell us what happened, what went wrong, and what you expected to happen.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

.github/workflows/bump-version.yml

@@ -9,21 +9,19 @@ on:
       - .editorconfig
       - .github/**.yml
       - .gitignore
-      - .gitlab-ci.yml
-      - .gitmodules
       - .pre-commit-config.yaml
       - .yamllint.yaml
       - AUTHORS.rst
       - CONTRIBUTING.rst
-      - docs/notebooks
+      - HISTORY.rst
+      - MANIFEST.in
+      - Makefile
       - docs/*.py
       - docs/*.rst
-      - environment-dev.yml
+      - docs/notebooks
+      - environment-docs.yml
       - environment.yml
-      - CHANGES.rst
-      - Makefile
-      - MANIFEST.in
-      - requirements_upstream.txt
+      - requirements_dev.txt
       - setup.cfg
       - setup.py
       - tests/**.py
@@ -35,8 +33,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          persist-credentials: false
       - uses: actions/setup-python@v4
         with:
           python-version: "3.x"
@@ -57,4 +53,4 @@ jobs:
         with:
           force: false
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: ${{ github.ref }}
+          branch: ${{ github.ref }}

.github/workflows/first_pull_request.yml

@@ -0,0 +1,46 @@
+name: First Pull Request
+
+on:
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  welcome:
+    name: Welcome
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            // Get a list of all issues created by the PR opener
+            // See: https://octokit.github.io/rest.js/#pagination
+            const creator = context.payload.sender.login
+            const opts = github.rest.issues.listForRepo.endpoint.merge({
+              ...context.issue,
+              creator,
+              state: 'all'
+            })
+            const issues = await github.paginate(opts)
+
+            for (const issue of issues) {
+              if (issue.number === context.issue.number) {
+                continue
+              }
+
+              if (issue.pull_request) {
+                return // Creator is already a contributor.
+              }
+            }
+
+            await github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `**Welcome**, new contributor!
+
+                It appears that this is your first Pull Request. To give credit where it's due, we ask that you add your information to the \`AUTHORS.rst\` and \`.zenodo.json\`.:
+                 - [ ] The relevant author information has been added to \`AUTHORS.rst\` and \`.zenodo.json\`.
+
+                Please make sure you've read our [contributing guide](CONTRIBUTING.rst). We look forward to reviewing your Pull Request shortly ✨`
+            })

.github/workflows/gh-pages.yml

@@ -1,36 +1,36 @@
-name: Docs
+name: Deploy Documentation
+
 on:
   push:
     branches:
       - master
   pull_request:
     branches:
       - master
+
 permissions:
   contents: write
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
-        uses: actions/checkout@v2.3.1 # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
+        uses: actions/checkout@v3
+      - uses: mamba-org/setup-micromamba@v1
         with:
-          persist-credentials: false
-      - uses: conda-incubator/setup-miniconda@v2
-        with:
-          activate-environment: xhydro
           environment-file: environment.yml
-          mamba-version: "*"
-          python-version: "3.10"
-          auto-activate-base: false
+          cache-environment: true
+          create-args: >-
+              python=3.10
       - name: Deploy docs
         shell: bash -l {0}
         run: |
           python -m ipykernel install --user --name=xhydro
           pip install -e .
           make -C docs html
       - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4.2.2
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
           branch: gh-pages # The branch the action should deploy to.
-          folder: docs/_build/html # The folder the action should deploy.
+          folder: docs/_build/html # The folder the action should deploy.