Skip to content

Commit 2d0ffcd

Browse files
seismanMeghan Jones
andauthored
Add description for more workflows (#980)
Co-authored-by: Meghan Jones <[email protected]>
1 parent 1b4aa90 commit 2d0ffcd

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

MAINTENANCE.md

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,43 +47,58 @@ conda and the `Makefile` to run the tests and checks.
4747

4848
### GitHub Actions
4949

50-
There are 5 configuration files located in `.github/workflows`:
50+
There are 8 configuration files located in `.github/workflows`:
5151

5252
1. `style_checks.yaml` (Code lint and style checks)
5353

54-
This is ran on every commit to the *master* and Pull Request branches.
55-
It is also scheduled to run daily on the *master* branch.
54+
This is run on every commit to the *master* and Pull Request branches.
55+
It is also scheduled to run daily on the *master* branch.
5656

5757
2. `ci_tests.yaml` (Tests on Linux/macOS/Windows)
5858

59-
This is ran on every commit to the *master* and Pull Request branches.
60-
It is also scheduled to run daily on the *master* branch.
61-
In draft Pull Requests, only one job (Ubuntu + Python latest)
62-
is triggered to save on Continuous Integration resources.
59+
This is run on every commit to the *master* and Pull Request branches.
60+
It is also scheduled to run daily on the *master* branch.
61+
In draft Pull Requests, only one job (Ubuntu + Python latest)
62+
is triggered to save on Continuous Integration resources.
6363

64-
On the *master* branch, the workflow also handles the documentation deployment:
64+
On the *master* branch, the workflow also handles the documentation
65+
deployment:
6566

66-
* Updating the development documentation by pushing the built HTML pages from the
67-
*master* branch onto the `dev` folder of the *gh-pages* branch.
68-
* Updated the `latest` documentation link to the new release.
67+
* Updating the development documentation by pushing the built HTML pages
68+
from the *master* branch onto the `dev` folder of the *gh-pages* branch.
69+
* Updating the `latest` documentation link to the new release.
6970

7071
3. `ci_tests_dev.yaml` (GMT Dev Tests on Linux/macOS/Windows).
7172

72-
This is triggered when a PR is marked as "ready for review", or using the slash
73-
command `/test-gmt-dev`. It is also scheduled to run daily on the *master* branch.
73+
This is triggered when a PR is marked as "ready for review", or using the
74+
slash command `/test-gmt-dev`. It is also scheduled to run daily on the
75+
*master* branch.
7476

7577
4. `cache_data.yaml` (Caches GMT remote data files needed for GitHub Actions CI)
7678

77-
This is scheduled to run every Sunday at 12 noon.
78-
If new remote files are needed urgently, maintainers can manually uncomment
79-
the 'pull_request:' line in that `cache_data.yaml` file to refresh the cache.
79+
This is scheduled to run every Sunday at 12:00 (UTC).
80+
If new remote files are needed urgently, maintainers can manually uncomment
81+
the 'pull_request:' line in that `cache_data.yaml` file to refresh the cache.
8082

8183
5. `publish-to-pypi.yml` (Publish wheels to PyPI and TestPyPI)
8284

83-
This workflow is ran to publish wheels to PyPI and TestPyPI (for testing only).
84-
Archives will be pushed to TestPyPI on every commit to the *master* branch and
85-
tagged releases, and to PyPI for tagged releases only.
85+
This workflow is run to publish wheels to PyPI and TestPyPI (for testing only).
86+
Archives will be pushed to TestPyPI on every commit to the *master* branch
87+
and tagged releases, and to PyPI for tagged releases only.
8688

89+
6. `release-drafer.yml` (Drafts the next release notes)
90+
91+
This workflow is run to update the next releases notes as pull requests are
92+
merged into master.
93+
94+
7. `check-links.yml` (Check links in the repository and website)
95+
96+
This workflow is run weekly to check all external links in plaintext and
97+
HTML files. It will create an issue if broken links are found.
98+
99+
8. `format-command.yml` (Format the codes using slash command)
100+
101+
This workflow is triggered in a PR if the slash command `/format` is used.
87102

88103
## Continuous Documentation
89104

0 commit comments

Comments
 (0)