Skip to content

Commit 7b17f61

Browse files
ci: Build docs action update (#65)
1 parent 6990885 commit 7b17f61

File tree

6 files changed

+54
-5
lines changed

6 files changed

+54
-5
lines changed

.github/workflows/build-docs.yml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Build Docs
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
paths:
8+
- 'docs/**'
9+
push:
10+
branches:
11+
- master
12+
paths:
13+
- 'docs/**'
14+
15+
jobs:
16+
docs:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v2
20+
- uses: borales/[email protected]
21+
- name: Set up Python
22+
uses: actions/setup-python@v1
23+
with:
24+
python-version: "3.8"
25+
- name: Capture branch and tag
26+
id: branch_name
27+
run: |
28+
echo ::set-env name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
29+
echo ::set-env name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
30+
31+
- name: install dependencies
32+
run: make dev-docs
33+
- name: Build docs website
34+
run: make build-docs-website

.github/workflows/build.yml

+10
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,19 @@ on:
44
pull_request:
55
branches:
66
- master
7+
paths:
8+
- 'powertools-core/**'
9+
- 'powertools-logging/**'
10+
- 'powertools-sqs/**'
11+
- 'powertools-tracing/**'
712
push:
813
branches:
914
- master
15+
paths:
16+
- 'powertools-core/**'
17+
- 'powertools-logging/**'
18+
- 'powertools-sqs/**'
19+
- 'powertools-tracing/**'
1020

1121
jobs:
1222
build:

.github/workflows/docs.yml

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
name: Docs
22

33
on:
4-
push:
5-
branches:
6-
- master
74
release:
85
types:
96
- published

docs/content/core/logging.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public class App implements RequestHandler<APIGatewayProxyRequestEvent, APIGatew
101101
You can also explicitly log any incoming event using `logEvent` param.
102102

103103
<Note type="warning">
104-
This is disabled by default to prevent sensitive info being logged.
104+
This is disabled by default to prevent sensitive info being logged.
105105
</Note><br/>
106106

107107
```java:title=App.java

docs/content/dummy.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Dummy title
3+
description: Dummy description
4+
---
5+
6+
## Test
7+
8+
dummy content

docs/content/utilities/sqs_large_message_handling.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The utility automatically retrieves messages which have been offloaded to S3 usi
1111
client library. Once the message payloads have been processed successful the
1212
utility can delete the message payloads from S3.
1313

14-
This utility is compatible with versions *1.1.0+* of amazon-sqs-java-extended-client-lib.</p>
14+
This utility is compatible with versions *1.1.0+* of amazon-sqs-java-extended-client-lib.
1515

1616
```xml
1717
<dependency>

0 commit comments

Comments
 (0)