Merge branch 'master' into hlines-module

Author: michaelgrund

.github/release-drafter.yml

@@ -5,26 +5,29 @@ categories:
     label: 'feature'
   - title: 'Enhancements'
     label: 'enhancement'
-  - title: 'Documentation'
-    label: 'documentation'
+  - title: 'Deprecations'
+    label: 'deprecation'
   - title: 'Bug Fixes'
     label: 'bug'
+  - title: 'Documentation'
+    label: 'documentation'
   - title: 'Maintenance'
     label: 'maintenance'
-  - title: 'Deprecations'
-    label: 'deprecation'
 exclude-labels:
   - 'skip-changelog'
-change-template: '* $TITLE (#$NUMBER)'
+category-template: '### $TITLE'
+change-template: '* $TITLE ([#$NUMBER]($URL))'
 template: |
-  [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524)
+  ## Release v$NEXT_PATCH_VERSION (20YY/MM/DD)
+
+  [![Digital Object Identifier for PyGMT v$NEXT_PATCH_VERSION](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524)
 
-  ## Highlights
+  ### Highlights
 
   *
 
   $CHANGES
 
-  ## Contributors
+  ### Contributors
 
   $CONTRIBUTORS

.github/workflows/check-links.yml

@@ -0,0 +1,55 @@
+# This workflow checks the links in plaintext and HTML files
+name: Check Links
+
+on:
+  # Uncomment the 'pull_request' line below to trigger the workflow in PR
+  # pull_request:
+  # Schedule runs on 12 noon every Sunday
+  schedule:
+    - cron: '0 12 * * 0'
+
+jobs:
+  check_links:
+    name: Check Links
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout the repository
+      uses: actions/checkout@v2.3.4
+      with:
+        path: repository
+
+    - name: Checkout the documentation
+      uses: actions/checkout@v2.3.4
+      with:
+        ref: gh-pages
+        path: documentation
+
+    - name: Link Checker
+      uses: lycheeverse/lychee-action@v1.0.4
+      with:
+        # 429: Too many requests
+        args: >
+          --accept 429
+          --exclude "^https://zenodo.org/badge/DOI/$"
+          --exclude "^https://github.com/GenericMappingTools/pygmt/pull/[0-9]*$"
+          --exclude "^https://github.com/GenericMappingTools/pygmt/issues/[0-9]*$"
+          --exclude "^https://www.generic-mapping-tools.org/_static/gmt-logo.png/$"
+          --exclude "^https://www.generic-mapping-tools.org/_static/gmt-logo.png/n/n$"
+          --exclude "^``@ridge.txt$"
+          --exclude "^git"
+          --exclude "^file://"
+          --exclude "^https://docs.generic-mapping-tools.org/latest/%s$"
+          --verbose
+          "repository/**/*.rst"
+          "repository/**/*.md"
+          "repository/**/*.py"
+          "documentation/dev/**/*.html"
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Create Issue From File
+      uses: peter-evans/create-issue-from-file@v2.3.2
+      with:
+        title: Link Checker Report
+        content-filepath: ./lychee/out.md

.github/workflows/ci_tests.yaml

@@ -86,7 +86,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.11.0
+        uses: dawidd6/action-download-artifact@v2.11.1
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.github/workflows/ci_tests_dev.yaml

@@ -95,7 +95,7 @@ jobs:
 
       # Download cached remote files (artifacts) from GitHub
       - name: Download remote data from GitHub
-        uses: dawidd6/action-download-artifact@v2.11.0
+        uses: dawidd6/action-download-artifact@v2.11.1
         with:
           workflow: cache_data.yaml
           workflow_conclusion: success

.pylintrc

@@ -141,7 +141,8 @@ disable=print-statement,
         comprehension-escape,
         attribute-defined-outside-init,
         bad-continuation,
-        import-error
+        import-error,
+        duplicate-code
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

README.rst

@@ -132,7 +132,7 @@ contribute. What could you possibly offer?
 We assure you that the little voice in your head is wrong.
 
 **Being a contributor doesn't just mean writing code**.
-Equality important contributions include: writing or proof-reading documentation,
+Equally important contributions include: writing or proof-reading documentation,
 suggesting or implementing tests, or even giving feedback about the project (including
 giving feedback about the contribution process). If you're coming to the project with
 fresh eyes, you might see the errors and assumptions that seasoned contributors have