Skip to content

ci: Build docs action update #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Build Docs

on:
pull_request:
branches:
- master
paths:
- 'docs/**'
push:
branches:
- master
paths:
- 'docs/**'

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: borales/[email protected]
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: "3.8"
- name: Capture branch and tag
id: branch_name
run: |
echo ::set-env name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
echo ::set-env name=SOURCE_TAG::${GITHUB_REF#refs/tags/}

- name: install dependencies
run: make dev-docs
- name: Build docs website
run: make build-docs-website
10 changes: 10 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,19 @@ on:
pull_request:
branches:
- master
paths:
- 'powertools-core/**'
- 'powertools-logging/**'
- 'powertools-sqs/**'
- 'powertools-tracing/**'
push:
branches:
- master
paths:
- 'powertools-core/**'
- 'powertools-logging/**'
- 'powertools-sqs/**'
- 'powertools-tracing/**'

jobs:
build:
Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Docs

on:
push:
branches:
- master
release:
types:
- published
Expand Down
2 changes: 1 addition & 1 deletion docs/content/core/logging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public class App implements RequestHandler<APIGatewayProxyRequestEvent, APIGatew
You can also explicitly log any incoming event using `logEvent` param.

<Note type="warning">
This is disabled by default to prevent sensitive info being logged.
This is disabled by default to prevent sensitive info being logged.
</Note><br/>

```java:title=App.java
Expand Down
8 changes: 8 additions & 0 deletions docs/content/dummy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Dummy title
description: Dummy description
---

## Test

dummy content
2 changes: 1 addition & 1 deletion docs/content/utilities/sqs_large_message_handling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The utility automatically retrieves messages which have been offloaded to S3 usi
client library. Once the message payloads have been processed successful the
utility can delete the message payloads from S3.

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

```xml
<dependency>
Expand Down