diff --git a/.github/actions/entrypoint.sh b/.github/actions/entrypoint.sh index 75ede785..a78e4f09 100644 --- a/.github/actions/entrypoint.sh +++ b/.github/actions/entrypoint.sh @@ -3,7 +3,7 @@ cd "${GITHUB_WORKSPACE}" # Python Dependencies -pip --no-cache-dir install git+https://github.com/linkchecker/linkchecker@v10.1.0#egg=linkchecker +pip --no-cache-dir install git+https://github.com/linkchecker/linkchecker@v10.3.0#egg=linkchecker # NodeJS Dependencies npm ci diff --git a/.github/workflows/check-build.yml b/.github/workflows/check-build.yml new file mode 100644 index 00000000..b55eb08c --- /dev/null +++ b/.github/workflows/check-build.yml @@ -0,0 +1,34 @@ +name: Build Check + +on: + pull_request: + branches: [ main ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +env: + TITLE: OKD.io + +jobs: + build: + runs-on: ubuntu-24.04 + steps: + - name: Checkout Repo + uses: actions/checkout@v4 + - name: Install dependencies (Python) + run: pip install -r requirements.txt --break-system-packages + - name: Install dependencies (Node) + run: npm ci + - name: Spellcheck + run: ./node_modules/.bin/cspell "docs/**/*.md" + - name: Build the site + run: mkdocs build --strict --clean --verbose + - name: Upload built site + uses: actions/upload-artifact@v4 + with: + name: okd.io + path: public/ + if-no-files-found: error + - name: Log any discovered broken links + run: linkchecker -f linkcheckerrc public || true diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml deleted file mode 100644 index 0ab673c7..00000000 --- a/.github/workflows/main.yml +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: CI - -on: - pull_request: - branches: [ main ] - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -jobs: - build: - runs-on: ubuntu-latest - container: - image: quay.io/fedora/fedora:latest - - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v2 - - - name: Install NPM - run: | - dnf install -y nodejs npm - - - name: Install PIP - run: | - dnf install -y python3-pip - - - name: Install Git - run: | - dnf install -y git - - - name: Install required dependencies - run: | - pip3 install -r requirements.txt - npm ci - - - name: Run the build - run: | - export PATH=$PATH:node_modules/.bin/ - ./build.sh diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 60660451..e2f799ba 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -3,23 +3,30 @@ name: Publish on: push: branches: [ main ] + workflow_dispatch: -jobs: - publish: - - runs-on: ubuntu-latest - - env: - NODE_VERSION: 12.x - TITLE: OKD.io +env: + TITLE: OKD.io +jobs: + build: + runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v2 - - name: generate site - uses: ./.github/actions/ - - - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + - name: Checkout Repo + uses: actions/checkout@v4 + - name: Install dependencies (Python) + run: pip install -r requirements.txt --break-system-packages + - name: Install dependencies (Node) + run: npm ci + - name: Spellcheck + run: ./node_modules/.bin/cspell "docs/**/*.md" + - name: Build the site + run: mkdocs gh-deploy --strict --clean --verbose -d public + - name: Upload built site + uses: actions/upload-artifact@v4 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./public \ No newline at end of file + name: okd.io + path: public/ + if-no-files-found: error + - name: Log any discovered broken links + run: linkchecker -f linkcheckerrc public || true diff --git a/docs/scos-migration-faq.md b/docs/scos-migration-faq.md index 4bfe15f5..4ab3a048 100644 --- a/docs/scos-migration-faq.md +++ b/docs/scos-migration-faq.md @@ -1,5 +1,7 @@ # FAQ - OKD Components based on SCOS + + This FAQ document relates to the builds of OKD that use CentOS Stream CoreOS (SCOS) after work done to stop using RHEL as the base for cluster components, as well as the upgrade path from pre-4.16 OKD FCOS/SCOS installations. *Holding Page* diff --git a/mkdocs.yml b/mkdocs.yml index dd82f1fe..143e4cba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ site_name: OKD.io site_description: >- The Community Distribution of Kubernetes that powers Red Hat OpenShift -site_url: https://openshift-cs.github.io/okd.io/index.html +site_url: https://okd.io/ site_author: Brian Innes repo_name: "okd-io" repo_url: https://github.com/okd-project/okd.io diff --git a/requirements.txt b/requirements.txt index f8ad8001..736e5ad5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,6 @@ mkdocs==1.6.0 mkdocs-material==9.5.25 mkdocs-minify-plugin==0.8.0 -git+https://github.com/linkchecker/linkchecker@v10.3.0#egg=linkchecker +linkchecker==10.4.0 +pymdown-extensions==10.8.1 +mkdocs-material[imaging]==9.5.25