Update docs

Signed-off-by: Sora Morimoto <sora@morimoto.io>

Author: smorimoto

EXAMPLES.md

@@ -38,7 +38,7 @@ jobs:
       - name: Set-up OCaml
         uses: ocaml/setup-ocaml@v3
         with:
-          ocaml-compiler: "5.2"
+          ocaml-compiler: 5
 
       - name: Install dependencies
         run: opam install . --deps-only --with-doc
@@ -106,7 +106,7 @@ steps:
   - name: Set-up OCaml
     uses: ocaml/setup-ocaml@v3
     with:
-      ocaml-compiler: "5.2"
+      ocaml-compiler: 5
       cache-prefix: v1-${{ matrix.container }}
       opam-disable-sandboxing: true
 ```

README.md

@@ -21,11 +21,8 @@ methods to do this.
 name: Builds, tests & co
 
 on:
-  pull_request:
-  push:
-  schedule:
-    # Prime the caches every Monday
-    - cron: 0 1 * * MON
+  - push
+  - pull_request
 
 permissions: read-all
 
@@ -35,8 +32,8 @@ jobs:
       fail-fast: false
       matrix:
         os:
-          - macos-latest
           - ubuntu-latest
+          - macos-latest
           - windows-latest
 
     runs-on: ${{ matrix.os }}
@@ -48,7 +45,7 @@ jobs:
       - name: Set-up OCaml
         uses: ocaml/setup-ocaml@v3
         with:
-          ocaml-compiler: "5.2"
+          ocaml-compiler: 5
 
       - run: opam install . --deps-only --with-test
 
@@ -123,6 +120,7 @@ Examples:
 - Exact package name: `ocaml-base-compiler.5.2.0`
 - Combine multiple packages:
   `ocaml-variants.5.2.0+options,ocaml-option-flambda,ocaml-option-musl,ocaml-option-static`
+- Major versions: `4`, `5`
 - Minor versions: `4.08`, `4.14`, `5.2`, `5.2.x`
 - More specific versions: `~4.02.2`, `5.1.0`
 

analysis/README.md

@@ -5,20 +5,32 @@
 ### Example workflow
 
 ```yml
+name: Opam Dependency Submission
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: opam-dependency-submission
+  cancel-in-progress: true
+
+permissions: read-all
+
 jobs:
   opam-dependency-submission:
+    permissions:
+      contents: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout tree
         uses: actions/checkout@v4
-
       - name: Set-up OCaml
         uses: ocaml/setup-ocaml@v3
         with:
-          ocaml-compiler: "5.2"
-
-      - name: Opam Dependency Submission
-        uses: ocaml/setup-ocaml/analysis@v3
+          ocaml-compiler: 5
+      - uses: ocaml/setup-ocaml/analysis@v3
 ```
 
 ## Inputs

lint-doc/README.md

@@ -11,14 +11,11 @@ jobs:
     steps:
       - name: Checkout tree
         uses: actions/checkout@v4
-
       - name: Set-up OCaml
         uses: ocaml/setup-ocaml@v3
         with:
-          ocaml-compiler: "5.2"
-
-      - name: Lint doc
-        uses: ocaml/setup-ocaml/lint-doc@v3
+          ocaml-compiler: 5
+      - uses: ocaml/setup-ocaml/lint-doc@v3
 ```
 
 ## Inputs

lint-fmt/README.md

@@ -14,14 +14,11 @@ jobs:
     steps:
       - name: Checkout tree
         uses: actions/checkout@v4
-
       - name: Set-up OCaml
         uses: ocaml/setup-ocaml@v3
         with:
-          ocaml-compiler: "5.2"
-
-      - name: Lint fmt
-        uses: ocaml/setup-ocaml/lint-fmt@v3
+          ocaml-compiler: 5
+      - uses: ocaml/setup-ocaml/lint-fmt@v3
 ```
 
 ## Inputs

lint-opam/README.md

@@ -11,14 +11,11 @@ jobs:
     steps:
       - name: Checkout tree
         uses: actions/checkout@v4
-
       - name: Set-up OCaml
         uses: ocaml/setup-ocaml@v3
         with:
-          ocaml-compiler: "5.2"
-
-      - name: Lint opam
-        uses: ocaml/setup-ocaml/lint-opam@v3
+          ocaml-compiler: 5
+      - uses: ocaml/setup-ocaml/lint-opam@v3
 ```
 
 ## Inputs