Skip to content

Commit 1595cb1

Browse files
committed
Merge branch 'main' into mambaforge
2 parents 70f5921 + 7a7e861 commit 1595cb1

File tree

542 files changed

+13539
-5184
lines changed

Some content is hidden

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

542 files changed

+13539
-5184
lines changed

.codecov.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

.dvc/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/config.local
2+
/tmp
3+
/cache

.dvc/config

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[core]
2+
remote = upstream
3+
['remote "upstream"']
4+
url = https://dagshub.com/GenericMappingTools/pygmt.dvc

.dvcignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Add patterns of files dvc should ignore, which could improve
2+
# the performance. Learn more at
3+
# https://dvc.org/doc/user-guide/dvcignore
Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,44 @@
11
---
22
name: PyGMT release checklist
33
about: Checklist for a new PyGMT release.
4-
title: Release PyGMT x.x.x
4+
title: Release PyGMT vX.Y.Z
55
labels: maintenance
66
assignees: ''
77

88
---
99

10-
**Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/0.x.x)
10+
**Release**: [v0.x.x](https://github.com/GenericMappingTools/pygmt/milestones/?)
1111
**Scheduled Date**: YYYY/MM/DD
12+
**Pull request due date**: YYYY/MM/DD
13+
14+
**Priority PRs/issues to complete prior to release**
15+
- [ ] Wrap X ()
16+
- [ ] Wrap Y ()
1217

1318
**Before release**:
1419
- [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version"
15-
- [ ] Update Changelog
16-
- [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher
17-
- [ ] Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt
20+
- [ ] Finish up 'Changelog entry for v0.x.x' Pull Request:
21+
- [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher
22+
- [ ] Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt
23+
- [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions
24+
- [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmt-and-pythonnumpy-versions
25+
- [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog))
1826

1927
**Release**:
20-
- [ ] Go to [GitHub Release](https://github.com/GenericMappingTools/pygmt/releases) and make a release, this will automatically create a tag too
21-
- [ ] Manually upload the pygmt-vX.Y.Z.zip file to https://zenodo.org/deposit, make sure you file it under the correct reserved DOI
28+
- [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases):
29+
- [ ] Edit the draft release notes with the finalized changelog
30+
- [ ] Set the tag version and release title to vX.Y.Z
31+
- [ ] Make a release by clicking the 'Publish Release' button, this will automatically create a tag too
32+
- [ ] Manually upload the pygmt-vX.Y.Z.zip and baseline-images.zip files to https://zenodo.org/deposit, ensure that it is filed under the correct reserved DOI
2233

2334
**After release**:
2435
- [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Usually done automatically by conda-forge's bot]
25-
- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt
36+
- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update)
2637
- [ ] Announce the release on:
27-
- [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/)
38+
- [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status)
2839
- [ ] [Major/Minor releases only] GMT [website](https://github.com/GenericMappingTools/website) (News)
29-
- [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools)
30-
40+
- [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools) (after forum announcement)
41+
- [ ] [Twitter](https://twitter.com/gmt_dev) (after forum announcement)
3142
---
3243

3344
- [ ] Party :tada: (don't tick before all other checkboxes are ticked!)

.github/codecov.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
codecov:
2+
notify:
3+
require_ci_to_pass: no
4+
5+
coverage:
6+
status:
7+
project:
8+
default:
9+
target: auto # increase overall coverage on each pull request
10+
threshold: 0.25% # Allow the coverage to drop by X%
11+
if_not_found: success
12+
if_ci_failed: failure
13+
patch:
14+
default:
15+
target: 90% # >=90% of new changes should be tested
16+
if_not_found: success
17+
if_ci_failed: failure
18+
19+
comment: off

.github/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
########################################################################################
33
# Comment to be posted to on first time issues
44
newIssueWelcomeComment: |
5-
👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our [contributing guidelines](https://github.com/GenericMappingTools/pygmt/blob/master/CONTRIBUTING.md) and [code of conduct](https://github.com/GenericMappingTools/pygmt/blob/master/CODE_OF_CONDUCT.md).
5+
👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our [contributing guidelines](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/GenericMappingTools/pygmt/blob/main/CODE_OF_CONDUCT.md).
66
77
# Comment to be posted to on PRs from first time contributors in your repository
88
newPRWelcomeComment: |
99
💖 Thanks for opening this pull request! 💖
1010
11-
Please make sure you read our [contributing guidelines](https://github.com/GenericMappingTools/pygmt/blob/master/CONTRIBUTING.md) and abide by our [code of conduct](https://github.com/GenericMappingTools/pygmt/blob/master/CODE_OF_CONDUCT.md).
11+
Please make sure you read our [contributing guidelines](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md) and abide by our [code of conduct](https://github.com/GenericMappingTools/pygmt/blob/main/CODE_OF_CONDUCT.md).
1212
1313
A few things to keep in mind:
1414

.github/release-drafter.yml

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,38 @@
1-
name-template: 'v$NEXT_PATCH_VERSION'
2-
tag-template: 'v$NEXT_PATCH_VERSION'
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
version-resolver:
4+
minor:
5+
labels:
6+
- 'feature'
7+
default: patch
38
categories:
49
- title: 'New Features'
510
label: 'feature'
611
- title: 'Enhancements'
712
label: 'enhancement'
8-
- title: 'Documentation'
9-
label: 'documentation'
13+
- title: 'Deprecations'
14+
label: 'deprecation'
1015
- title: 'Bug Fixes'
1116
label: 'bug'
17+
- title: 'Documentation'
18+
label: 'documentation'
1219
- title: 'Maintenance'
1320
label: 'maintenance'
14-
- title: 'Deprecations'
15-
label: 'deprecation'
1621
exclude-labels:
1722
- 'skip-changelog'
18-
change-template: '* $TITLE (#$NUMBER)'
23+
category-template: '### $TITLE'
24+
change-template: '* $TITLE ([#$NUMBER]($URL))'
1925
template: |
20-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524)
26+
## Release v$RESOLVED_VERSION (20YY/MM/DD)
27+
28+
[![Digital Object Identifier for PyGMT v$RESOLVED_VERSION](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524)
2129
22-
## Highlights
30+
### Highlights
2331
2432
*
2533
2634
$CHANGES
2735
28-
## Contributors
36+
### Contributors
2937
3038
$CONTRIBUTORS

.github/workflows/cache_data.yaml

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,41 @@ jobs:
1212
gmt_cache:
1313
name: Cache GMT artifacts
1414
runs-on: macOS-latest
15+
defaults:
16+
run:
17+
shell: bash -l {0}
1518

1619
steps:
20+
# Checkout current git repository
21+
- name: Checkout
22+
uses: actions/[email protected]
23+
with:
24+
# fecth all history so that setuptools-scm works
25+
fetch-depth: 0
26+
1727
# Setup Miniconda
1828
- name: Setup Miniconda
19-
uses: conda-incubator/setup-miniconda@v2.0.1
29+
uses: conda-incubator/setup-miniconda@v2.1.1
2030
with:
2131
channels: conda-forge
2232
miniconda-version: "latest"
2333

24-
# Install GMT
25-
- name: Install GMT
26-
shell: bash -l {0}
27-
run: conda install -c conda-forge gmt=6.1.1
34+
# Install GMT and other required dependencies from conda-forge
35+
- name: Install dependencies
36+
run: |
37+
conda install gmt=6.2.0 \
38+
numpy pandas xarray netCDF4 packaging matplotlib
39+
40+
# Install the package that we want to test
41+
- name: Install the package
42+
run: |
43+
python setup.py sdist --formats=zip
44+
pip install dist/*
2845
2946
# Download remote files
3047
- name: Download remote data
31-
shell: bash -l {0}
3248
run: |
33-
gmt which -Ga @earth_relief_10m_p @earth_relief_10m_g \
34-
@earth_relief_30m_p @earth_relief_30m_g \
35-
@earth_relief_01d_p @earth_relief_01d_g \
36-
@earth_relief_05m_p @earth_relief_05m_g
37-
gmt which -Ga @ridge.txt @Table_5_11.txt @test.dat.nc \
38-
@tut_bathy.nc @tut_quakes.ngdc @tut_ship.xyz \
39-
@usgs_quakes_22.txt
49+
python -c "from pygmt.helpers.testing import download_test_data; download_test_data()"
4050
4151
# Upload the downloaded files as artifacts to GitHub
4252
- name: Upload artifacts to GitHub

.github/workflows/check-links.yml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# This workflow checks the links in plaintext and HTML files
2+
name: Check Links
3+
4+
on:
5+
# Uncomment the 'pull_request' line below to trigger the workflow in PR
6+
# pull_request:
7+
# Schedule runs on 12 noon every Sunday
8+
schedule:
9+
- cron: '0 12 * * 0'
10+
11+
jobs:
12+
check_links:
13+
name: Check Links
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout the repository
18+
uses: actions/[email protected]
19+
with:
20+
path: repository
21+
22+
- name: Checkout the documentation
23+
uses: actions/[email protected]
24+
with:
25+
ref: gh-pages
26+
path: documentation
27+
28+
- name: Link Checker
29+
uses: lycheeverse/[email protected]
30+
with:
31+
# 429: Too many requests
32+
args: >
33+
--accept 429
34+
--exclude "^https://doi.org/10.5281/zenodo$"
35+
--exclude "^https://zenodo.org/badge/DOI/$"
36+
--exclude "^https://zenodo.org/badge/DOI/10.5281/zenodo$"
37+
--exclude "^https://github.com/GenericMappingTools/pygmt/pull/[0-9]*$"
38+
--exclude "^https://github.com/GenericMappingTools/pygmt/issues/[0-9]*$"
39+
--exclude "^https://www.generic-mapping-tools.org/_static/gmt-logo.png/$"
40+
--exclude "^https://www.generic-mapping-tools.org/_static/gmt-logo.png/n/n$"
41+
--exclude "^``@ridge.txt$"
42+
--exclude "^git"
43+
--exclude "^file://"
44+
--exclude "^https://docs.generic-mapping-tools.org/latest/%s$"
45+
--exclude "https://hackmd.io/@pygmt"
46+
--verbose
47+
"repository/**/*.rst"
48+
"repository/**/*.md"
49+
"repository/**/*.py"
50+
"documentation/dev/**/*.html"
51+
env:
52+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
53+
54+
- name: Create Issue From File
55+
uses: peter-evans/create-issue-from-file@v3
56+
with:
57+
title: Link Checker Report
58+
content-filepath: ./lychee/out.md

0 commit comments

Comments
 (0)