Update dependency cspell to v8.16.1 (v2) #3670
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
name: Build | |
on: | |
- push | |
- pull_request | |
jobs: | |
pre-checks: | |
name: Resolve Pre-Checks | |
runs-on: ubuntu-22.04 | |
if: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name }} | |
steps: | |
- name: Print Info | |
run: | | |
echo "Branch push or external pull request detected" | |
build: | |
name: Build Website | |
runs-on: ubuntu-22.04 | |
needs: pre-checks | |
outputs: | |
timestamp: ${{ steps.timestamp.outputs.timestamp }} | |
steps: | |
- name: Checkout Website Repository | |
uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Resolve tinylog Version | |
run: | | |
pip3 install yq | |
echo "TINYLOG_VERSION=$(yq -r '.params.stableVersion' config.yaml)" >> $GITHUB_ENV | |
- name: Install Node.js | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18 | |
- name: Install Java | |
uses: actions/setup-java@v4 | |
with: | |
java-version: 8 | |
distribution: zulu | |
- name: Install Dependencies | |
run: npm install | |
- name: Build Website | |
run: npm run build:prod | |
- name: Checkout tinylog Repository | |
uses: actions/checkout@v4 | |
with: | |
repository: tinylog-org/tinylog | |
ref: ${{ env.TINYLOG_VERSION }} | |
path: tinylog | |
- name: Generate API documentation | |
run: | | |
cd tinylog/tinylog-api | |
mvn -P release --no-transfer-progress --batch-mode javadoc:javadoc | |
- name: Copy API documentation | |
run: | | |
rm -r public/v2/javadoc/* | |
cp -R tinylog/tinylog-api/target/site/apidocs/* public/v2/javadoc | |
- name: Generate timestamp | |
id: timestamp | |
run: echo "timestamp=$(date +'%Y%m%d-%H%M')" >> $GITHUB_OUTPUT | |
- name: Upload Generated Files | |
uses: actions/upload-artifact@v4 | |
with: | |
name: website-${{ steps.timestamp.outputs.timestamp }} | |
path: public/ | |
lint-markdown: | |
name: Lint Markdown | |
runs-on: ubuntu-22.04 | |
needs: pre-checks | |
steps: | |
- name: Checkout Website Repository | |
uses: actions/checkout@v4 | |
- name: Check Markdown | |
uses: DavidAnson/markdownlint-cli2-action@v16 | |
with: | |
globs: "content/**/*.md" | |
check-spelling: | |
name: Check Spelling | |
runs-on: ubuntu-22.04 | |
needs: pre-checks | |
steps: | |
- name: Checkout Website Repository | |
uses: actions/checkout@v4 | |
- name: Install Node.js | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18 | |
- name: Install Dependencies | |
run: npm install | |
- name: Run CSpell | |
run: npm run cspell:check | |
validate-html: | |
name: Validate HTML | |
runs-on: ubuntu-22.04 | |
needs: build | |
steps: | |
- name: Download Generated Files | |
uses: actions/download-artifact@v4 | |
with: | |
name: website-${{ needs.build.outputs.timestamp }} | |
path: public/ | |
- name: Validate HTML | |
uses: Cyb3r-Jak3/[email protected] | |
with: | |
log_level: INFO | |
skip_git_check: true | |
root: public/ | |
blacklist: javadoc | |
check-links: | |
name: Check Links | |
runs-on: ubuntu-22.04 | |
needs: build | |
steps: | |
- name: Download Generated Files | |
uses: actions/download-artifact@v4 | |
with: | |
name: website-${{ needs.build.outputs.timestamp }} | |
path: public/ | |
- name: Check Links | |
uses: ruzickap/action-my-broken-link-checker@v2 | |
with: | |
url: https://tinylog.org/v2 | |
pages_path: public | |
cmd_params: "--exclude=(tinylog.org/(v[^2]|p2-repository)/|github.com/tinylog-org/website/edit/) --max-connections-per-host=2 --rate-limit=10 --accepted-status-codes=200,403 --buffer-size=8192 --color=always" |