Moved submodule spec to .ciignore for reproducibility

ahelwer · ahelwer · commit 710f08898424 · 2025-05-21T08:50:46.000-04:00
Signed-off-by: Andrew Helwer &lt;ahelwer@pm.me&gt;
diff --git a/.ciignore b/.ciignore
@@ -9,4 +9,5 @@ specifications/doesnotexist
 specifications/BlockingQueue
 specifications/CCF
 specifications/azure-cosmos-tla
+specifications/microwave
 
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -30,8 +30,6 @@ jobs:
     steps:
       - name: Clone repo
         uses: actions/checkout@v4
-        with: 
-          submodules: true
       - name: Install python
         uses: actions/setup-python@v5
         with:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,6 +8,8 @@ The spec will also enjoy basic maintenance over the years, ensuring it remains f
 To ensure a high bar of quality, all specs in this repo are subject to automated continuous integration tests.
 This means the spec contribution process has some amount of configuration & overhead, which can occasionally bring frustration.
 If you are willing to push through this yourself that is greatly appreciated, but if it becomes an undue obstacle you can also add your spec directory to the [`.ciignore`](.ciignore) file to exclude your spec from validation; maintainers can then integrate it into the CI system at a later date.
+Your spec must be contributed to the repository directly.
+For reproducibility, contributing your spec as a git submodule is not supported.
 
 Licensing your contributed specs under MIT is most appreciated, for consistency; however, other compatible permissive licenses are accepted.
 
diff --git a/README.md b/README.md
@@ -98,7 +98,6 @@ Here is a list of specs included in this repository, with links to the relevant
 | [Condition-Based Consensus](specifications/cbc_max)                                                 | Thanh Hai Tran, Igor Konnov, Josef Widder           |          |             |         |           |          |
 | [Buffered Random Access File](specifications/braf)                                                  | Calvin Loncaric                                     |          |             |         |     ✔     |          |
 | [Disruptor](specifications/Disruptor)                                                               | Nicholas Schultz-Møller                             |          |             |         |     ✔     |          |
-| [Simple Microwave Oven](specifications/microwave)                                                   | Konstantin Läufer, George K. Thiruvathukal          |     ✔    |             |         |     ✔     |          |
 
 
 ## Examples Elsewhere
@@ -145,6 +144,7 @@ Ideally these will be moved into this repo over time.
 | [Petri Nets](https://github.com/elh/petri-tlaplus)                                                                                | Instantiable Petri Nets with liveness properties                                                                                          | Eugene Huang                                                               |          |             |     ✔     |         |          |
 | [CRDT](https://github.com/JYwellin/CRDT-TLA)                                                                                      | Specifying and Verifying CRDT Protocols                                                                                                   | Ye Ji, Hengfeng Wei                                                        |          |             |     ✔     |         |          |
 | [Azure Cosmos DB](https://github.com/tlaplus/azure-cosmos-tla)                                                                    | Consistency models provided by Azure Cosmos DB                                                                                            | Dharma Shukla, Ailidani Ailijiang, Murat Demirbas, Markus Kuppe            |          |             |     ✔     |    ✔    |          |
+| [Simple Microwave Oven](specifications/microwave)                                                                                 | Spec of a microwave oven                                                                                                                  | Konstantin Läufer, George K. Thiruvathukal                        |    ✔    |         |             |     ✔     |         |          |
 
 ## Contributing a Spec
 
