From 507331da73ddcba9ee1e325237e3335788c0965f Mon Sep 17 00:00:00 2001 From: Pankaj Agrawal Date: Mon, 31 Aug 2020 19:35:08 +0200 Subject: [PATCH 1/3] ci:Deploy doc on release and build on master+PR --- .github/workflows/build-docs.yml | 34 ++++++++++++++++++++++++++++++++ .github/workflows/docs.yml | 3 --- docs/content/core/logging.mdx | 2 +- 3 files changed, 35 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 000000000..f2e5e5cb5 --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -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/actions-yarn@v2.0.0 + - 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 \ No newline at end of file diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a79af691e..5eb6d98bd 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,9 +1,6 @@ name: Docs on: - push: - branches: - - master release: types: - published diff --git a/docs/content/core/logging.mdx b/docs/content/core/logging.mdx index 6f21c8844..ff55afcfe 100644 --- a/docs/content/core/logging.mdx +++ b/docs/content/core/logging.mdx @@ -101,7 +101,7 @@ public class App implements RequestHandler - This is disabled by default to prevent sensitive info being logged. + This is disabled by default to prevent sensitive info being logged.
```java:title=App.java From 2fbac672fbdd78568a07a6c752786e6afdc9ba0d Mon Sep 17 00:00:00 2001 From: Pankaj Agrawal Date: Mon, 31 Aug 2020 19:47:50 +0200 Subject: [PATCH 2/3] Build source code only on specific source folders paths --- .github/workflows/build.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index adb4f9b14..a1c0cca50 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -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: From c9c935ad034177f290c5264f0721419de56dda0d Mon Sep 17 00:00:00 2001 From: Pankaj Agrawal Date: Mon, 31 Aug 2020 19:09:34 +0200 Subject: [PATCH 3/3] fix: doc build failures --- docs/content/core/logging.mdx | 2 +- docs/content/dummy.md | 8 ++++++++ docs/content/utilities/sqs_large_message_handling.mdx | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 docs/content/dummy.md diff --git a/docs/content/core/logging.mdx b/docs/content/core/logging.mdx index ff55afcfe..865b73432 100644 --- a/docs/content/core/logging.mdx +++ b/docs/content/core/logging.mdx @@ -101,7 +101,7 @@ public class App implements RequestHandler - This is disabled by default to prevent sensitive info being logged. + This is disabled by default to prevent sensitive info being logged.
```java:title=App.java diff --git a/docs/content/dummy.md b/docs/content/dummy.md new file mode 100644 index 000000000..d53b2cc3b --- /dev/null +++ b/docs/content/dummy.md @@ -0,0 +1,8 @@ +--- +title: Dummy title +description: Dummy description +--- + +## Test + +dummy content \ No newline at end of file diff --git a/docs/content/utilities/sqs_large_message_handling.mdx b/docs/content/utilities/sqs_large_message_handling.mdx index 0b334ad6f..cb6cee41f 100644 --- a/docs/content/utilities/sqs_large_message_handling.mdx +++ b/docs/content/utilities/sqs_large_message_handling.mdx @@ -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.

+This utility is compatible with versions *1.1.0+* of amazon-sqs-java-extended-client-lib. ```xml