Skip to content

Commit 9e975bc

Browse files
committed
Add GitHub Actions and CONTRIBUTING.md
- Temporarily comment out some deploy steps until we have resolved plone#1146
1 parent 09530f8 commit 9e975bc

File tree

3 files changed

+74
-0
lines changed

3 files changed

+74
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See our [contributing guidelines](https://training.plone.org/5/contributing/index.html).

.github/workflows/build_deploy.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
2+
name: Build and deploy Plone 6 documentation to 6-dev.docs.plone.org
3+
4+
on:
5+
push:
6+
branches:
7+
- '6-dev'
8+
9+
jobs:
10+
build_deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v1
14+
15+
- name: Set up Python ${{ matrix.python-version }}
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: 3.10
19+
20+
- name: Install dependencies
21+
run: |
22+
python -m pip install --upgrade pip
23+
pip install -q -r requirements.txt -c constraints.txt
24+
25+
- name: Run spellcheck
26+
run: make spellcheck
27+
28+
- name: Run linkcheck
29+
run: make linkcheck
30+
31+
# - name: Prepare deploy
32+
# run: make deploy
33+
#
34+
# - name: Deploy to server
35+
# id: deploy
36+
# uses: Pendect/[email protected]
37+
# env:
38+
# DEPLOY_KEY: ${{secrets.DEPLOY_KEY_TRAINING}}
39+
# with:
40+
# flags: '-avzr --delete'
41+
# options: ''
42+
# ssh_options: '-p ${{secrets.DEPLOY_PORT}}'
43+
# src: '_build/html/'
44+
# dest: '${{secrets.DEPLOY_USER_TRAINING}}@${{secrets.DEPLOY_SERVER_TRAINING}}:${{secrets.DEPLOY_PATH_TRAINING}}/5'
45+
#
46+
# - name: Display status from deploy
47+
# run: echo "${{ steps.deploy.outputs.status }}"

.github/workflows/test.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
name: Test Plone 6 documentation
3+
4+
on:
5+
push:
6+
branches-ignore:
7+
- 'master'
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v1
14+
15+
- name: Set up Python ${{ matrix.python-version }}
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: 3.10
19+
20+
- name: Install dependencies
21+
run: |
22+
python -m pip install --upgrade pip
23+
pip install -q -r requirements.txt -c constraints.txt
24+
25+
- name: Run tests with make test
26+
run: make test

0 commit comments

Comments
 (0)