Skip to content

Commit 59711d3

Browse files
author
James (ODSC)
authored
Merge pull request #4 from OpenDataServices/github-actions
GitHub actions
2 parents b610f1b + 74b7b90 commit 59711d3

File tree

3 files changed

+24
-16
lines changed

3 files changed

+24
-16
lines changed

.github/workflows/linkcheck.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Link Check
2+
on: [push, pull_request]
3+
4+
jobs:
5+
linkcheck:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/checkout@v2
9+
- name: Setup python
10+
uses: actions/setup-python@v2
11+
with:
12+
python-version: 3.6
13+
architecture: x64
14+
- uses: actions/cache@v1
15+
with:
16+
path: ~/.cache/pip
17+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
18+
- run: pip install -r requirements.txt
19+
- run: cd ./docs/ && make dirhtml
20+
- run: cd ./docs/ && make linkcheck
21+

.travis.yml

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

docs/patterns/documentation.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ e.g. for OCDS we have:
145145
```eval_rst
146146
* Changelog - http://standard.open-contracting.org/latest/en/schema/changelog/
147147
* History of every individual change to the OCDS docs/schema - https://github.com/open-contracting/standard/commits/1.1
148-
* When was each line in any given file last changed - https://github.com/open-contracting/standard/blame/1.1/standard/schema/release-schema.json
148+
* When was each line in any given file last changed - https://github.com/open-contracting/standard/blame/1.1/schema/release-schema.json
149149
```
150150

151151
### Related patterns
@@ -270,11 +270,11 @@ We use two different automated build services, for different projects:
270270

271271
(1) [Read the docs](https://readthedocs.org/) is designed specifically for building Sphinx docs. It will rebuild a version of the documentation every time a commit if pushed to the corresponding branch on GitHub. Read the Docs being designed specifically for Sphinx is useful because it will automatically hosts the docs, and provides a version/language switcher out of the docs. It gives a lot of control (e.g. you can have whatever custom directives and theming you want, you can point a custom domain at it), but is less flexible than a generic build service. It also requires a manual step to add a new branch/version to the docs. We use Read the Docs for lots of smaller docs sites
272272

273-
(2) [Travis](https://travis-ci.org/) - is a generic build service (again building every time something is pushed to GitHub), so requires a bit more setup than Read the Docs, but also gives you maximum flexibility over what commands get run. It can also run tests of the documentation/schema before the build. It doesn’t host docs, but can be set up to push the built docs to a hosting provider of your choice.
273+
(2) [GitHub Actions](https://github.com/features/actions) - is a generic build service (again building every time something is pushed to GitHub), so requires a bit more setup than Read the Docs, but also gives you maximum flexibility over what commands get run. It can also run tests of the documentation/schema before the build. It doesn’t host docs, but can be set up to push the built docs to a hosting provider of your choice.
274274

275275
### Example
276276

277-
For OCDS we have a [travis script](https://github.com/open-contracting/standard/blob/1.1-dev/.travis.yml) that runs the tests and deploys all the branches.
277+
For OCDS we have a [GitHub Actions script](https://github.com/open-contracting/standard/blob/1.1-dev/.github/workflows/ci.yml) that runs the tests and deploys all the branches.
278278

279279
### Related patterns
280280

@@ -377,8 +377,6 @@ The build process can be configured so that the symlink for full **releases** of
377377

378378
Currently we only use this approach for OCDS.
379379

380-
Here's the [section about copying file to the server in the OCDS handbook](https://ocds-standard-development-handbook.readthedocs.io/en/latest/standard/technical/deployment/#copy-the-files-to-the-live-server).
381-
382380
```eval_rst
383381
.. todo::
384382

0 commit comments

Comments
 (0)