Skip to content

Commit 30728fd

Browse files
authored
Revert the migration from Vercel App to Vercel action (#973)
* Revert "Disable pull_request_target for the vercel action (#969)" This reverts commit f455c31. * Revert "Use Vercel action for continuous documentation (#964)" This reverts commit 17133d1.
1 parent 4db28ef commit 30728fd

File tree

4 files changed

+22
-103
lines changed

4 files changed

+22
-103
lines changed

.github/workflows/continuous-documentation.yml

-92
This file was deleted.

MAINTENANCE.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ conda and the `Makefile` to run the tests and checks.
4747

4848
### GitHub Actions
4949

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

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

@@ -84,19 +84,16 @@ This workflow is ran to publish wheels to PyPI and TestPyPI (for testing only).
8484
Archives will be pushed to TestPyPI on every commit to the *master* branch and
8585
tagged releases, and to PyPI for tagged releases only.
8686

87-
6. `continuous-documentation.yml` (Deploy documentation to Vercel for preview)
88-
89-
This workflow builds and deploys the documentation in Pull Requests to Vercel,
90-
to make it easier to preview documentation changes.
9187

9288
## Continuous Documentation
9389

94-
We use a cloud platform service called [Vercel](https://vercel.com/) via
95-
[vercel-action](https://github.com/marketplace/actions/vercel-action) to
96-
preview changes made to our documentation website every time we make a commit
97-
in a pull request. The workflow `continuous-documentation.yml` builds and
98-
deploys the documentation to Vercel. The vercel bot will automatically make a
99-
comment with a URL to preview the deployed documentation for that pull request.
90+
We use the [Vercel for GitHub](https://github.com/apps/vercel) App to preview changes
91+
made to our documentation website every time we make a commit in a pull request.
92+
The service has a configuration file `vercel.json`, with a list of options to
93+
change the default behaviour at https://vercel.com/docs/configuration.
94+
The actual script `package.json` is used by Vercel to install the necessary packages,
95+
build the documentation, copy the files to a 'public' folder and deploy that to the web,
96+
see https://vercel.com/docs/build-step.
10097

10198
## Making a Release
10299

package.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"scripts": {
3+
"build:miniconda": "curl -o ~/miniconda.sh https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh && bash ~/miniconda.sh -b -p $HOME/miniconda",
4+
"build:pygmt": "conda install mamba -c conda-forge -y && mamba env create -f environment.yml && source activate pygmt && make install",
5+
"build:docs": "source activate pygmt && cd doc && make all && mv _build/html ../public",
6+
"build": "export PATH=$HOME/miniconda/bin:$PATH && npm run build:miniconda && npm run build:pygmt && npm run build:docs"
7+
}
8+
}

vercel.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"github": {
3+
"silent": true
4+
},
5+
"public": true
6+
}

0 commit comments

Comments
 (0)