diff --git a/.github/workflows/try-in-web-ide.yaml b/.github/workflows/add-web-ide-link.yaml similarity index 79% rename from .github/workflows/try-in-web-ide.yaml rename to .github/workflows/add-web-ide-link.yaml index 1231dce6d..aca3b7f82 100644 --- a/.github/workflows/try-in-web-ide.yaml +++ b/.github/workflows/add-web-ide-link.yaml @@ -7,15 +7,16 @@ # # SPDX-License-Identifier: EPL-2.0 # -# Add Web IDE link on PRs -name: web-ide - +# Add Web IDE link on pull requests +name: Add Web IDE link on: pull_request_target: - types: [opened, synchronize] - + types: + - opened + - synchronize jobs: add-link: + name: Add Web IDE link runs-on: ubuntu-20.04 steps: - name: Web IDE Pull Request Check diff --git a/.github/workflows/build-and-publish-to-github-pages.yaml b/.github/workflows/build-and-publish-to-github-pages.yaml index 28a3b1739..f0514b2a1 100644 --- a/.github/workflows/build-and-publish-to-github-pages.yaml +++ b/.github/workflows/build-and-publish-to-github-pages.yaml @@ -14,9 +14,11 @@ name: Publish to GitHub Pages on: push: - branches: [main] + branches: + - main jobs: - build: + publish: + name: Publish to GitHub Pages runs-on: ubuntu-latest steps: - name: Checkout repository diff --git a/.github/workflows/build-and-validate-on-pr.yaml b/.github/workflows/build-and-validate-on-pr.yaml index e5a778ebb..fc3c7367a 100644 --- a/.github/workflows/build-and-validate-on-pr.yaml +++ b/.github/workflows/build-and-validate-on-pr.yaml @@ -9,14 +9,12 @@ # # Name is reused in `publish-netlify.yml` -name: "Build and validate pull request" - +name: Build and validate pull request on: - pull_request - jobs: build: - name: "Build and validate pull request" + name: Build and validate pull request runs-on: ubuntu-20.04 container: "quay.io/eclipse/che-docs:latest" steps: @@ -28,30 +26,25 @@ jobs: - name: Build using antora # and fail on warning id: antora-build run: CI=true antora generate antora-playbook-for-development.yml --stacktrace 2>&1 | (tee | grep WARNING && exit 42 || exit 0) - - name: Upload artifact doc-content uses: actions/upload-artifact@v2 with: name: doc-content path: build/site - - name: Store PR info for publish-netlify run: | echo "${{ github.event.number }}" > PR_NUMBER echo "${{ github.event.pull_request.head.sha }}" > PR_SHA - - name: Upload artifact pull-request-number for publish-netlify uses: actions/upload-artifact@v2 with: name: pull-request-number path: PR_NUMBER - - name: Upload artifact pull-request-sha for publish-netlify uses: actions/upload-artifact@v2 with: name: pull-request-sha path: PR_SHA - - name: Cache htmltest status code of checked external URLs # See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows uses: actions/cache@v2 env: @@ -59,7 +52,6 @@ jobs: with: key: refcache.json path: .cache/htmltest - - name: Validate links using htmltest id: validate-links run: htmltest diff --git a/.github/workflows/build-and-validate-on-push.yaml b/.github/workflows/build-and-validate-on-push.yaml index aaf491e52..a8f4d5f6e 100644 --- a/.github/workflows/build-and-validate-on-push.yaml +++ b/.github/workflows/build-and-validate-on-push.yaml @@ -11,12 +11,12 @@ # GitHub Actions configuration file for htmltest # See: https://github.com/wjdp/htmltest -name: Build and validate +name: Build and validate on push on: - push jobs: build: - name: Build and validate + name: Build and validate on push runs-on: ubuntu-20.04 container: "quay.io/eclipse/che-docs:latest" steps: @@ -24,17 +24,14 @@ jobs: uses: actions/checkout@v2 with: fetch-depth: 0 - - name: Build using antora id: antora-build run: CI=true antora generate antora-playbook-for-development.yml --stacktrace - - name: Upload artifact uses: actions/upload-artifact@v2 with: name: doc-content path: build/site - - name: Cache htmltest status code of checked external URLs # See: https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows uses: actions/cache@v2 env: @@ -42,7 +39,6 @@ jobs: with: key: refcache.json path: .cache/htmltest - - name: Validate links using htmltest id: validate-links run: htmltest diff --git a/.github/workflows/publish-netlify.yml b/.github/workflows/publish-netlify.yml index 220eaba84..eccf8c973 100644 --- a/.github/workflows/publish-netlify.yml +++ b/.github/workflows/publish-netlify.yml @@ -10,15 +10,13 @@ # NOTE: Because this worklow is using secrets, it cannot run directly on a pull-request workflow, which is running in the context of the forked repository. -name: Publish doc-content using netlify - +name: Publish pull request doc-content using netlify on: workflow_run: workflows: - "Build and validate pull request" types: - completed - jobs: publish: name: Publish doc-content using netlify diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 68ba13fd1..8aa0aae4d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,10 +1,20 @@ +--- +# +# Copyright (c) 2021 Red Hat, Inc. +# This program and the accompanying materials are made +# available under the terms of the Eclipse Public License 2.0 +# which is available at https://www.eclipse.org/legal/epl-2.0/ +# +# SPDX-License-Identifier: EPL-2.0 +# name: Release on: push: branches: - main jobs: - prose: + release: + name: Release runs-on: ubuntu-latest steps: - name: Checkout diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index a9fa489a0..6e9acefa4 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -1,14 +1,23 @@ +--- +# +# Copyright (c) 2021 Red Hat, Inc. +# This program and the accompanying materials are made +# available under the terms of the Eclipse Public License 2.0 +# which is available at https://www.eclipse.org/legal/epl-2.0/ +# +# SPDX-License-Identifier: EPL-2.0 +# name: Linting with Vale on: - pull_request - push jobs: - prose: + vale: + name: Linting with Vale runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@master - - name: Vale Linter uses: errata-ai/vale-action@v1.4.0 with: diff --git a/.vale.ini b/.vale.ini index 3332e81ef..70db404e9 100644 --- a/.vale.ini +++ b/.vale.ini @@ -32,7 +32,9 @@ SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, properties = md # Match AsciiDoc files. See: https://docs.errata.ai/vale/scoping -[*.adoc] +# Ignore files in a directory starting by `.` +# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files +[[!.]*.adoc] # Styles to load, located in the `StylesPath` folder: BasedOnStyles = RedHat diff --git a/_config.yml b/_config.yml deleted file mode 100644 index c74188174..000000000 --- a/_config.yml +++ /dev/null @@ -1 +0,0 @@ -theme: jekyll-theme-slate \ No newline at end of file