Skip to content

Commit 5f67979

Browse files
authored
Merge branch 'main' into wrap-clip
2 parents ff1dac4 + 6921f58 commit 5f67979

File tree

214 files changed

+4065
-1972
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

214 files changed

+4065
-1972
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-32
This file was deleted.
+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Bug report
2+
description: Report a problem/bug to help us improve
3+
labels: bug
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
attributes:
11+
label: "Description of the problem"
12+
description: |
13+
Please be as detailed as you can when describing an issue.
14+
The more information we have, the easier it will be for us to track this down.
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: "Minimal Complete Verifiable Example"
20+
description: |
21+
So that we can understand and fix the issue quickly and efficiently, please provide
22+
a minimal, self-contained copy-pastable example that demonstrates the issue.
23+
For more details, check out:
24+
25+
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
26+
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
27+
28+
placeholder: "PASTE CODE HERE"
29+
render: python
30+
validations:
31+
required: false
32+
- type: textarea
33+
attributes:
34+
label: "Full error message"
35+
description: "What was the error message you got?"
36+
placeholder: "PASTE ERROR MESSAGE HERE"
37+
render: python-traceback
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: "System information"
43+
description: |
44+
Please paste the output of `python -c "import pygmt; pygmt.show_versions()"`
45+
If this command is not successful, please describe your operating system, how you installed PyGMT, how you installed GMT, and paste the full error message.
46+
placeholder: "PASTE THE OUTPUT HERE"
47+
render: bash
48+
validations:
49+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

-19
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Feature request - General feature
2+
description: Request the addition of a new feature/functionality
3+
labels: ["feature request"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: "Description of the desired feature"
8+
description: |
9+
Please be as detailed as you can in your description.
10+
If possible, include an example of how you would like to use this feature (even better if it's a code example).
11+
- type: dropdown
12+
id: help
13+
attributes:
14+
label: Are you willing to help implement and maintain this feature?
15+
description: |
16+
Every feature we add is code that we will have to maintain and keep updated. This takes a lot of effort.
17+
If you are willing to be involved in the project and help maintain your feature, it will make it easier for us to accept it.
18+
options:
19+
- "No"
20+
- "Yes"
21+
- "Maybe"
22+
validations:
23+
required: true

.github/ISSUE_TEMPLATE/module_request.md

-31
This file was deleted.
+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Feature request - Wrap a new GMT module
2+
description: Request PyGMT wrapper for a GMT module
3+
title: "Wrapper for <module-name>"
4+
labels: ["feature request"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please replace `<module-name>` in the issue title and the description with the name of the requested module and add the description of the module.
10+
- type: textarea
11+
id: which-module
12+
attributes:
13+
label: Description of the desired module
14+
description: Please be as detailed as you can in your description. If possible, include an example of how you would like to use this feature (even better if it's a code example).
15+
placeholder: Implement [`<module-name>`](https://docs.generic-mapping-tools.org/latest/<module-name>.html) which `<insert description of the GMT module>`.
16+
validations:
17+
required: true
18+
- type: dropdown
19+
id: help
20+
attributes:
21+
label: Are you willing to help implement and maintain this feature?
22+
description: |
23+
Every feature we add is code that we will have to maintain and keep updated. This takes a lot of effort.
24+
If you are willing to be involved in the project and help maintain your feature, it will make it easier for us to accept it.
25+
options:
26+
- "No"
27+
- "Yes"
28+
- "Maybe"
29+
validations:
30+
required: true
31+
- type: markdown
32+
attributes:
33+
value: |
34+
Progress on wrapping the module will be tracked in the [project board](https://github.com/GenericMappingTools/pygmt/projects/9).

.github/PULL_REQUEST_TEMPLATE.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Fixes #
1616
- [ ] Write detailed docstrings for all functions/methods.
1717
- [ ] If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
1818
- [ ] If adding new functionality, add an example to docstrings or tutorials.
19+
- [ ] Use underscores (not hyphens) in names of Python files and directories.
1920

2021
**Slash Commands**
2122

.github/workflows/cache_data.yaml

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,21 @@ jobs:
1919
steps:
2020
# Checkout current git repository
2121
- name: Checkout
22-
uses: actions/checkout@v3.0.2
22+
uses: actions/checkout@v3.2.0
2323
with:
2424
# fetch all history so that setuptools-scm works
2525
fetch-depth: 0
2626

2727
# Install Mambaforge with conda-forge dependencies
2828
- name: Setup Mambaforge
29-
uses: conda-incubator/setup-miniconda@v2.1.1
29+
uses: conda-incubator/setup-miniconda@v2.2.0
3030
with:
3131
channels: conda-forge,nodefaults
3232
channel-priority: strict
3333
miniforge-version: latest
3434
miniforge-variant: Mambaforge
3535
mamba-version: "*"
36+
run-post: false
3637
use-mamba: true
3738

3839
# Install GMT and other required dependencies from conda-forge

.github/workflows/check-links.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ jobs:
1515

1616
steps:
1717
- name: Checkout the repository
18-
uses: actions/checkout@v3.0.2
18+
uses: actions/checkout@v3.2.0
1919
with:
2020
path: repository
2121

2222
- name: Checkout the documentation
23-
uses: actions/checkout@v3.0.2
23+
uses: actions/checkout@v3.2.0
2424
with:
2525
ref: gh-pages
2626
path: documentation
2727

2828
- name: Link Checker
29-
uses: lycheeverse/[email protected].1
29+
uses: lycheeverse/[email protected].4
3030
with:
3131
# 429: Too many requests
3232
args: >

.github/workflows/ci_docs.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ on:
1010
paths-ignore:
1111
- 'pygmt/tests/**'
1212
- '*.md'
13-
- '*.json'
1413
- 'LICENSE.txt'
1514
- '.gitignore'
1615
release:
@@ -43,20 +42,20 @@ jobs:
4342
steps:
4443
# Cancel previous runs that are not completed
4544
- name: Cancel Previous Runs
46-
uses: styfle/cancel-workflow-action@0.10.0
45+
uses: styfle/cancel-workflow-action@0.11.0
4746
with:
4847
access_token: ${{ github.token }}
4948

5049
# Checkout current git repository
5150
- name: Checkout
52-
uses: actions/checkout@v3.0.2
51+
uses: actions/checkout@v3.2.0
5352
with:
5453
# fetch all history so that setuptools-scm works
5554
fetch-depth: 0
5655

5756
# Install Mambaforge with conda-forge dependencies
5857
- name: Setup Mambaforge
59-
uses: conda-incubator/setup-miniconda@v2.1.1
58+
uses: conda-incubator/setup-miniconda@v2.2.0
6059
with:
6160
activate-environment: pygmt
6261
python-version: ${{ matrix.python-version }}
@@ -65,6 +64,7 @@ jobs:
6564
miniforge-version: latest
6665
miniforge-variant: Mambaforge
6766
mamba-version: "*"
67+
run-post: false
6868
use-mamba: true
6969

7070
# Install GMT and other required dependencies from conda-forge
@@ -80,7 +80,7 @@ jobs:
8080

8181
# Download cached remote files (artifacts) from GitHub
8282
- name: Download remote data from GitHub
83-
uses: dawidd6/action-download-artifact@v2.22.0
83+
uses: dawidd6/action-download-artifact@v2.24.2
8484
with:
8585
workflow: cache_data.yaml
8686
workflow_conclusion: success
@@ -107,7 +107,7 @@ jobs:
107107
run: make -C doc clean all
108108

109109
- name: Checkout the gh-pages branch
110-
uses: actions/checkout@v3.0.2
110+
uses: actions/checkout@v3.2.0
111111
with:
112112
ref: gh-pages
113113
# Checkout to this folder instead of the current one

0 commit comments

Comments
 (0)