-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a6c1b06
commit c695eb8
Showing
209 changed files
with
15,074 additions
and
5,007 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"ignorePatterns": [ | ||
{ | ||
"pattern": "^http://localhost" | ||
}, | ||
{ | ||
"pattern": "^https://mvnrepository.com" | ||
}, | ||
{ | ||
"pattern": "^https://img.shields.io" | ||
}, | ||
{ | ||
"pattern": "^https://tokei.rs" | ||
}, | ||
{ | ||
"pattern": "^https://json.org/" | ||
}, | ||
{ | ||
"pattern": "^https://opencollective.com" | ||
} | ||
], | ||
"timeout": "30s", | ||
"retryOn429": true, | ||
"retryCount": 10, | ||
"fallbackRetryDelay": "1000s", | ||
"aliveStatusCodes": [ | ||
0, | ||
200, | ||
401, | ||
403 | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,33 +13,104 @@ | |
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
name: build_docs | ||
|
||
# execute this docs build workflow automatically when new push happens in any branch | ||
name: "Build documentation" | ||
on: | ||
push: | ||
paths: | ||
- 'docs/**' | ||
|
||
branches: | ||
- master | ||
- release-* | ||
pull_request: | ||
branches: | ||
- master | ||
- release-* | ||
|
||
jobs: | ||
|
||
build_docs_job: | ||
build-documentation: | ||
# if: github.repository == 'apache/flink-cdc-connectors' | ||
runs-on: ubuntu-latest | ||
container: debian:buster-slim | ||
|
||
strategy: | ||
max-parallel: 1 | ||
matrix: | ||
branch: | ||
# - master | ||
# - release-3.0 | ||
- master-cdc-new # need to delete this branch | ||
steps: | ||
|
||
- name: Prereqs | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
apt-get update | ||
apt-get install -y git | ||
git clone "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" . | ||
shell: bash | ||
|
||
- name: Execute script to build our documentation and update pages | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: "docs/build_docs.sh" | ||
shell: bash | ||
- uses: actions/checkout@v3 | ||
with: | ||
ref: ${{ matrix.branch }} | ||
|
||
- name: Set JDK | ||
uses: actions/setup-java@v3 | ||
with: | ||
java-version: 8 | ||
distribution: 'temurin' | ||
cache: 'maven' | ||
|
||
- name: Set Maven 3.8.6 | ||
uses: stCarolas/[email protected] | ||
with: | ||
maven-version: 3.8.6 | ||
|
||
- name: Set branch environment variable | ||
run: | | ||
currentBranch=$(git branch --show-current) | ||
echo "flink_branch=${currentBranch}" >> ${GITHUB_ENV} | ||
if [ "${currentBranch}" = "master" ]; then | ||
echo "flink_alias=release-3.1" >> ${GITHUB_ENV} | ||
elif [ "${currentBranch}" = "release-3.0" ]; then | ||
echo "flink_alias=stable" >> ${GITHUB_ENV} | ||
fi | ||
- name: Build documentation | ||
run: | | ||
HUGO_REPO=https://github.com/gohugoio/hugo/releases/download/v0.110.0/hugo_extended_0.110.0_Linux-64bit.tar.gz | ||
HUGO_ARTIFACT=hugo_extended_0.110.0_Linux-64bit.tar.gz | ||
if ! curl --fail -OL $HUGO_REPO ; then | ||
echo "Failed to download Hugo binary" | ||
exit 1 | ||
fi | ||
tar -zxvf $HUGO_ARTIFACT -C /usr/local/bin | ||
git submodule update --init --recursive | ||
|
||
hugo --source docs | ||
hugo -v --source docs --destination target | ||
|
||
mvn clean install -B -DskipTests -Dfast | ||
|
||
mkdir -p docs/target/api | ||
mvn javadoc:aggregate -B \ | ||
-DadditionalJOption="-Xdoclint:none --allow-script-in-comments" \ | ||
-Dmaven.javadoc.failOnError=false \ | ||
-Dcheckstyle.skip=true \ | ||
-Dspotless.check.skip=true \ | ||
-Denforcer.skip=true \ | ||
-Dheader="<a href=\"http://flink.apache.org/\" target=\"_top\"><h1>Back to Flink Website</h1></a> <script>var _paq=window._paq=window._paq||[];_paq.push([\"disableCookies\"]),_paq.push([\"setDomains\",[\"*.flink.apache.org\",\"*.nightlies.apache.org/flink\"]]),_paq.push([\"trackPageView\"]),_paq.push([\"enableLinkTracking\"]),function(){var u=\"//matomo.privacy.apache.org/\";_paq.push([\"setTrackerUrl\",u+\"matomo.php\"]),_paq.push([\"setSiteId\",\"1\"]);var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s)}();</script>" | ||
|
||
mv target/site/apidocs docs/target/api/java | ||
|
||
- name: Upload documentation | ||
uses: burnett01/[email protected] | ||
with: | ||
switches: --archive --compress | ||
path: docs/target/ | ||
remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink-cdc/flink-cdc-docs-${{ env.flink_branch }}/ | ||
remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }} | ||
remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }} | ||
remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }} | ||
remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }} | ||
|
||
- name: Upload documentation alias | ||
if: env.flink_alias != '' | ||
uses: burnett01/[email protected] | ||
with: | ||
switches: --archive --compress | ||
path: docs/target/ | ||
remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink-cdc/flink-cdc-docs-${{ env.flink_alias }}/ | ||
remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }} | ||
remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }} | ||
remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }} | ||
remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "docs/themes/book"] | ||
path = docs/themes/book | ||
url = https://github.com/alex-shpak/hugo-book |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
.bundle/ | ||
.jekyll-metadata | ||
.jekyll-cache/ | ||
.rubydeps/ | ||
ruby2/.bundle/ | ||
ruby2/.rubydeps/ | ||
public/ | ||
resources/ | ||
.hugo_build.lock | ||
.DS_Store |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.