fix: CI job must run on PR (#148)

CI job must run on PR Fix broken links in ADRs Signed-off-by: FabioPinheiro <fabiomgpinheiro@gmail.com>
hyperledger · Aug 13, 2024 · 2b9fc55 · 2b9fc55
1 parent 0950bfb
commit 2b9fc55
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 37 deletions.
diff --git a/.github/workflows/release-gh-pages.yml b/.github/workflows/release-gh-pages.yml
@@ -1,4 +1,5 @@
-name: Release gh-pages docs image
+name: Build & Deploy gh-pages
+run-name: CI on ${{ github.ref_name }}
 
 on:
   workflow_dispatch:
@@ -12,43 +13,31 @@ on:
     branches-ignore:
       - "gh-pages"
   push:
-    branches: [main,  gh-pages-test]
+    branches: [main]
     tags: ["v*"]
 
 jobs:
   ghpages:
-    name: Deploy gh-pages
+    name: Build and Deploy gh-pages
     runs-on: ubuntu-latest
-    if: (inputs.force_deploy_ghpages == true) || (github.ref == 'refs/heads/main') || startsWith(github.ref, 'refs/tags/v') || (github.ref == 'refs/heads/gh-pages-test')
     steps:
       # https://github.com/japgolly/setup-everything-scala
       - uses: actions/checkout@v4
         with:
           submodules: recursive
           fetch-depth: 0 # Needed for the release tag // `git fetch --tags` will also work
-      # - name: Setup Java and Scala
-      #   uses: olafurpg/setup-scala@v14
-      #   with:
-      #     java-version: adopt@1.11
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
           node-version: "lts/*"
-      # - name: Setup Scala.JS
-      #   uses: japgolly/setup-scalajs@v1
-      # - name: Cache sbt
-      #   uses: coursier/cache-action@v6.3
-
-      # ### create build deploy gh-pages ###
-      # - name: sbt "docAll; siteAll"
-      #   run: sbt -v "docAll; siteAll"
 
       - name: Build
         run: |
           yarn install
           yarn build
 
       - name: Deploy
+        if: (inputs.force_deploy_ghpages == true) || (github.ref == 'refs/heads/main') || startsWith(github.ref, 'refs/tags/v')
         # https://github.com/marketplace/actions/github-pages-action
         uses: peaceiris/actions-gh-pages@v3
         with:

diff --git a/.../decisions/20230206-use-flyway-to-manage-migrations-for-application-services.md b/.../decisions/20230206-use-flyway-to-manage-migrations-for-application-services.md
@@ -1,6 +1,6 @@
 # Use flyway to manage migrations for application services
 
-- Status: [ accepted | deprecated | superseded by [xxx](yyyymmdd-xxx.md)] <!-- optional -->
+- Status: [ accepted | deprecated | superseded by \[xxx\](yyyymmdd-xxx.md)] <!-- optional -->
 - Deciders: [list everyone involved in the decision] <!-- optional -->
 - Date: [YYYY-MM-DD when the decision was last updated] <!-- optional. To customize the ordering without relying on Git creation dates and filenames -->
 - Tags: [space and/or comma separated list of tags] <!-- optional -->
@@ -69,5 +69,5 @@ Chosen option: "[option 1]", because [justification. e.g., only option, which me
 
 ## Links <!-- optional -->
 
-- [Link type](link to adr) <!-- example: Refined by [xxx](yyyymmdd-xxx.md) -->
+- [Link type](link to adr) <!-- example: Refined by \[xxx\](yyyymmdd-xxx.md) -->
 - … <!-- numbers of links can vary -->
diff --git a/...n/adrs/decisions/20230206-use-scala3-instead-of-scala2-to-write-applications.md b/...n/adrs/decisions/20230206-use-scala3-instead-of-scala2-to-write-applications.md
@@ -1,6 +1,6 @@
 # Use Scala3 instead of Scala2 to write applications
 
-- Status: [ accepted | deprecated | superseded by [xxx](yyyymmdd-xxx.md)] <!-- optional -->
+- Status: [ accepted | deprecated | superseded by \[xxx\](yyyymmdd-xxx.md)] <!-- optional -->
 - Deciders: [list everyone involved in the decision] <!-- optional -->
 - Date: [YYYY-MM-DD when the decision was last updated] <!-- optional. To customize the ordering without relying on Git creation dates and filenames -->
 - Tags: [space and/or comma separated list of tags] <!-- optional -->
@@ -69,5 +69,5 @@ Chosen option: "[option 1]", because [justification. e.g. only option, which mee
 
 ## Links <!-- optional -->
 
-- [Link type](link to adr) <!-- example: Refined by [xxx](yyyymmdd-xxx.md) -->
+- [Link type](link to adr) <!-- example: Refined by \[xxx\](yyyymmdd-xxx.md) -->
 - … <!-- numbers of links can vary -->
diff --git a/...-zio-as-a-functional-effect-system-within-applications-to-manage-conccurency.md b/...-zio-as-a-functional-effect-system-within-applications-to-manage-conccurency.md
@@ -1,6 +1,6 @@
 # Use ZIO as a functional effect system within applications to manage conccurency
 
-- Status: [ accepted | deprecated | superseded by [xxx](yyyymmdd-xxx.md)] <!-- optional -->
+- Status: [ accepted | deprecated | superseded by \[xxx\](yyyymmdd-xxx.md)] <!-- optional -->
 - Deciders: [list everyone involved in the decision] <!-- optional -->
 - Date: [YYYY-MM-DD when the decision was last updated] <!-- optional. To customize the ordering without relying on Git creation dates and filenames -->
 - Tags: [space and/or comma separated list of tags] <!-- optional -->
@@ -69,5 +69,5 @@ Chosen option: "[option 1]", because [justification. e.g. only option, which mee
 
 ## Links <!-- optional -->
 
-- [Link type](link to adr) <!-- example: Refined by [xxx](yyyymmdd-xxx.md) -->
+- [Link type](link to adr) <!-- example: Refined by \[xxx\](yyyymmdd-xxx.md) -->
 - … <!-- numbers of links can vary -->
diff --git a/documentation/adrs/template.md b/documentation/adrs/template.md
@@ -74,5 +74,5 @@ Chosen option: "[option 1]", because [justification. e.g., only option, which me
 
 ## Links <!-- optional -->
 
-- [Link type](link to adr) <!-- example: Refined by [xxx](yyyymmdd-xxx.md) -->
+- [Link type](link to adr) <!-- example: Refined by \[xxx\](yyyymmdd-xxx.md) -->
 - … <!-- numbers of links can vary -->
diff --git a/src/pages/index.js b/src/pages/index.js
@@ -10,32 +10,32 @@ import AtalaGraphic from '../components/atala-graphic';
 import Blob from '../components/blob';
 import Button from '../components/button';
 function HomepageHeader() {
-  const {siteConfig} = useDocusaurusContext();
+  const { siteConfig } = useDocusaurusContext();
   return (
     <header className={clsx('hero', styles.heroBanner)}>
       <div className={clsx('container', styles.container)}>
-          <div className={styles.hero__content}>
-              <span className={clsx('hero__subtitle', styles.hero__tagline)}>{siteConfig.tagline}</span>
-              <h1 className={clsx('hero__title', styles.hero__title)} dangerouslySetInnerHTML={{__html: siteConfig.title}}/>
-                  <Button
-                      className={clsx("button button--lg", styles.hero__button)}
-                      to="/docs/getting-started">
-                      Get Started
-                  </Button>
-          </div>
-          <AtalaGraphic/>
+        <div className={styles.hero__content}>
+          <span className={clsx('hero__subtitle', styles.hero__tagline)}>{siteConfig.tagline}</span>
+          <h1 className={clsx('hero__title', styles.hero__title)} dangerouslySetInnerHTML={{ __html: siteConfig.title }} />
+          <Button
+            className={clsx("button button--lg", styles.hero__button)}
+            to="/docs/getting-started">
+            Get Started
+          </Button>
+        </div>
+        <AtalaGraphic />
       </div>
     </header>
   );
 }
 
 export default function Home() {
-  const {siteConfig} = useDocusaurusContext();
+  const { siteConfig } = useDocusaurusContext();
   return (
     <Layout
-      title={`H${siteConfig.title}`}
+      title={`${siteConfig.title}`}
       description="Description will go into a meta tag in <head />">
-        <Blob/>
+      <Blob />
       <HomepageHeader />
       <main>
         <HomepageFeatures />