Update super-linter configuration (#159)

* Update super-linter configuration - Bump version of super-linter to v6.3.0 - Configure the default branch correctly - Set less permissive permissions in CI * Fix header nesting in CONTRIBUTING.md * Enable VALIDATE_ALL_CODEBASE option * Fix CI status write permissions * Remove tutorial from web demo * Super linter should ignore Rust * Don't run shfmt * Switch to slim variant of super-linter --------- Co-authored-by: Tim Süberkrüb <[email protected]>
polarity-lang · Mar 22, 2024 · 7c7ef2d · 7c7ef2d
1 parent 5cadea1
commit 7c7ef2d
Show file tree

Hide file tree

Showing 14 changed files with 22 additions and 288 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -10,6 +10,10 @@ on:
       - opened
       - synchronize
 
+permissions:
+  contents: read
+  statuses: write
+
 env:
   CARGO_TERM_COLOR: always
 

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -10,21 +10,22 @@ on:
       - opened
       - synchronize
 
+permissions: read-all
+
 jobs:
   build:
     name: Lint Code Base
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Lint Code Base
-        uses: github/super-linter/slim@v4
+        uses: super-linter/super-linter/slim@v6.3.0
         env:
-          VALIDATE_ALL_CODEBASE: false
           # JSCPD is disabled because it falsely flags duplicated Rust generic parameter definitions
           VALIDATE_JSCPD: false
           # We use eslint instead of the linter named "standard"
@@ -33,5 +34,7 @@ jobs:
           TYPESCRIPT_DEFAULT_STYLE: prettier
           # We use a slightly different stylelint version/setup
           VALIDATE_CSS: false
-          DEFAULT_BRANCH: master
+          # We don't validate formatting of bash scripts
+          VALIDATE_SHELL_SHFMT: false
+          DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,12 +2,12 @@
 
 Pull requests, bug reports and feature requests are highly welcomed and encouraged!
 
-### Contents
+## Contents
 
 - [Pull Request Workflow](#pull-request-workflow)
 - [Release Workflow](#release-workflow)
 
-### Pull request workflow
+## Pull request workflow
 
 All changes to the codebase should go through pull-requests.
 We do not allow commits directly on the `main` branch of the repository.
@@ -18,7 +18,7 @@ Please check that you observe the following guidelines:
 - Every PR needs to have at least 1 approval before it can be merged.
 - We enforce a linear history on the `main` branch, so every PR must either be rebased or rebased and squashed before it is merged into `main`.
 
-### Release workflow
+## Release workflow
 
 We use the following workflow for generating a new release for version `x.x.x`:
 

diff --git a/web/packages/app/assets/tutorial.css → web/packages/app/assets/demo.css b/web/packages/app/assets/tutorial.css → web/packages/app/assets/demo.css
diff --git a/web/packages/app/assets/tutorial.html → web/packages/app/assets/demo.html b/web/packages/app/assets/tutorial.html → web/packages/app/assets/demo.html
@@ -4,7 +4,7 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
-  <title>Deriving Dependently-Typed OOP from First Principles</title>
+  <title>Polarity Demo</title>
 </head>
 
 <body>
@@ -30,14 +30,7 @@
   </script>
   <main class="container">
     <section>
-      <h1>Deriving Dependently-Typed OOP from First Principles</h1>
-
-      <p>This is the web demo accompanying the OOPSLA 2024 paper Deriving Dependently-Typed OOP from First Principles.
-        You
-        will find
-        the most recent version of the language on <a
-          href="https://polarity-lang.github.io">polarity-lang.github.io</a>.
-      </p>
+      <h1>Polarity Demo</h1>
 
       <nav>
         <ul>
@@ -69,49 +62,6 @@ <h1>Deriving Dependently-Typed OOP from First Principles</h1>
         <iframe class="editor-frame" id="editor-frame" src="./editor"></iframe>
       </div>
     </section>
-    <!-- Tutorial -->
-    <section id="tutorial">
-      <h4>Tutorial</h4>
-      <p>
-        This is a short overview of the syntax of our language.
-        Feel free to copy and paste sections of the tutorial code into the interactive editor above to try out the
-        examples on your own.
-      </p>
-
-      <details>
-        <summary><b>Data Types</b></summary>
-        {{ data-types }}
-      </details>
-
-      <details>
-        <summary><b>Codata Types</b></summary>
-        {{ codata-types }}
-      </details>
-
-      <details>
-        <summary><b>Definitions</b></summary>
-        {{ definitions }}
-      </details>
-
-      <details>
-        <summary><b>Codefinitions</b></summary>
-        {{ codefinitions }}
-      </details>
-
-      <details>
-        <summary><b>Comments</b></summary>
-        {{ comments }}
-      </details>
-
-      <details>
-        <summary><b>Typed Holes</b></summary>
-        {{ typed-holes }}
-      </details>
-      <details>
-        <summary><b>The Main Expression</b></summary>
-        {{ main-expression }}
-      </details>
-    </section>
   </main>
 </body>
 

diff --git a/web/packages/app/assets/tutorial/codata-types.md b/web/packages/app/assets/tutorial/codata-types.md
diff --git a/web/packages/app/assets/tutorial/codefinitions.md b/web/packages/app/assets/tutorial/codefinitions.md
diff --git a/web/packages/app/assets/tutorial/comments.md b/web/packages/app/assets/tutorial/comments.md
diff --git a/web/packages/app/assets/tutorial/data-types.md b/web/packages/app/assets/tutorial/data-types.md
diff --git a/web/packages/app/assets/tutorial/definitions.md b/web/packages/app/assets/tutorial/definitions.md
diff --git a/web/packages/app/assets/tutorial/main-expression.md b/web/packages/app/assets/tutorial/main-expression.md
diff --git a/web/packages/app/assets/tutorial/typed-holes.md b/web/packages/app/assets/tutorial/typed-holes.md
diff --git a/web/packages/app/src/tutorial/index.ts b/web/packages/app/src/tutorial/index.ts
@@ -1,4 +1,4 @@
-import "../../assets/tutorial.css";
+import "../../assets/demo.css";
 import * as highlight from "./highlight";
 import * as editor from "./editor";