Skip to content

Commit 8711804

Browse files
author
BlackstoneEngineering
committed
Merge remote-tracking branch 'origin/main' into patch-17-analytics
2 parents 4715f5f + 92e70b8 commit 8711804

File tree

668 files changed

+143615
-180
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

668 files changed

+143615
-180
lines changed

‎.github/workflows/build-check.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Build Check
2+
3+
on:
4+
pull_request:
5+
branches: [ "main" ]
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
build-checks:
12+
concurrency: ci-${{ github.ref }}
13+
runs-on: ubuntu-latest
14+
15+
strategy:
16+
matrix:
17+
node-version: [20.x]
18+
19+
steps:
20+
- uses: actions/checkout@v4
21+
- name: Use Node.js ${{ matrix.node-version }}
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ matrix.node-version }}
25+
cache: 'yarn'
26+
- name: Install Ruby
27+
uses: ruby/setup-ruby@v1
28+
with:
29+
ruby-version: '3.4.1' # Not needed with a .ruby-version, .tool-versions or mise.toml
30+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
31+
- name: Install Antora Dependencies
32+
run: |
33+
cd antora
34+
gem install bundler
35+
bundle install
36+
npm install
37+
38+
- name: Install Docusaurus dependencies
39+
run: yarn install
40+
41+
- name: Build website
42+
run: |
43+
cd antora
44+
npx antora antora-playbook.yml --stacktrace
45+
cd ..
46+
yarn build

‎.github/workflows/deploy-website.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Deploy Portal
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
7+
permissions:
8+
contents: write
9+
10+
jobs:
11+
deploy:
12+
concurrency: ci-${{ github.ref }}
13+
runs-on: ubuntu-latest
14+
15+
strategy:
16+
matrix:
17+
node-version: [20.x]
18+
19+
steps:
20+
- uses: actions/checkout@v4
21+
- name: Use Node.js ${{ matrix.node-version }}
22+
uses: actions/setup-node@v4
23+
with:
24+
node-version: ${{ matrix.node-version }}
25+
cache: 'yarn'
26+
- name: Install Ruby
27+
uses: ruby/setup-ruby@v1
28+
with:
29+
ruby-version: '3.4.1' # Not needed with a .ruby-version, .tool-versions or mise.toml
30+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
31+
- name: Install Antora Dependencies
32+
run: |
33+
cd antora
34+
gem install bundler
35+
bundle install
36+
npm install
37+
38+
- name: Install Docusaurus dependencies
39+
run: yarn install
40+
41+
- name: Build Antora
42+
continue-on-error: true
43+
run: |
44+
cd antora
45+
npx antora antora-playbook.yml --stacktrace
46+
47+
- name: Build Docusaurus
48+
# continue-on-error: true
49+
run: yarn build
50+
51+
- name: Deploy to GitHub Pages
52+
# run: yarn deploy
53+
uses: JamesIves/github-pages-deploy-action@v4
54+
with:
55+
folder: build # The folder the action should deploy.
56+
57+
- name: Upload Artifact Logs
58+
uses: actions/upload-artifact@v4
59+
if: ${{ always() }}
60+
with:
61+
name: Portal Snapshot
62+
path: ./build/

‎.github/workflows/linkchecker.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Link Checker
2+
env:
3+
WEBSITE_URL: "developer.riscv.org"
4+
5+
# Run this workflow every time a new commit pushed to your repository
6+
on:
7+
# Automatic Schedule Trigger
8+
schedule:
9+
# Run on 1st day of every month
10+
- cron: '0 0 1 * *'
11+
# Manual Trigger
12+
workflow_dispatch:
13+
inputs:
14+
logLevel:
15+
description: 'Log level'
16+
required: true
17+
default: 'warning'
18+
tags:
19+
description: 'Test scenario tags'
20+
21+
jobs:
22+
website-checker:
23+
name: Developer Portal Link Checker
24+
runs-on: ubuntu-latest
25+
continue-on-error: true
26+
steps:
27+
- name: Install Python
28+
uses: actions/setup-python@v5
29+
- name: Setup Environment
30+
run: |
31+
pip3 install git+https://github.com/linkchecker/linkchecker.git
32+
mkdir ./logs
33+
34+
- name: Check Links
35+
run: |
36+
linkchecker \
37+
--no-warnings \
38+
-t 100 \
39+
-o html \
40+
http://developer.riscv.org > ./logs/developer.riscv.org.html
41+
42+
- name: Process Link Log
43+
if: always()
44+
continue-on-error: true
45+
run: |
46+
echo LC_SUMMARY=$( awk '/\d* warnings found/' ./logs/developer.riscv.org.html) >> $GITHUB_ENV
47+
echo $(awk '/\d* warnings found/' ./logs/developer.riscv.org.html )
48+
echo $GITHUB_ENV
49+
50+
- name: Upload Artifact Logs
51+
uses: actions/upload-artifact@v4
52+
if: ${{ always() }}
53+
with:
54+
name: developer.riscv.org.html
55+
path: ./logs/developer.riscv.org.html
56+
57+
# # Slack Notification of broken links found
58+
# - name: Slack Notification
59+
# uses: rtCamp/action-slack-notify@v2
60+
# if: ${{ failure() }}
61+
# env:
62+
# SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
63+
# SLACK_CHANNEL: channel_name
64+
# SLACK_USERNAME: Link Checker Bot
65+
# SLACK_TITLE: WARNING - broken links found on $WEBSITE_URL
66+
# MSG_MINIMAL: true
67+
# SLACK_ICON_EMOJI: ':failed:'
68+
# SLACK_MESSAGE: |
69+
# `${{ env.LC_SUMMARY }}`
70+
# link check: broken links detected on $WEBSITE_URL. Please see report artifact.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
antora/build
22
antora/node_modules/
33
antora/yarn.lock
4+
antora/Gemfile.lock
45
.DS_Store
56
.docusaurus
67
build

‎antora/Gemfile.lock‎

Lines changed: 0 additions & 153 deletions
This file was deleted.

0 commit comments

Comments
 (0)