tests: Add a replay client (#26)

- **export at the end of file**
- **move github to subfolder**
- **tests: Add a replay client**
- **Migrate to ESM**
- **Migrate from ncc to rollup**

.env.test.example

@@ -0,0 +1 @@
+GH_TOKEN=

.gitignore

@@ -1,6 +1,5 @@
 # Logs
 logs
-*.log
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*

.vscode/settings.json

@@ -23,5 +23,8 @@
   },
   "[markdown]": {
     "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
+  },
+  "[dotenv]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
   }
 }

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- tests: Add a replay client
+- Migrate to ESM
+- Migrate from ncc to rollup
+- Migrate from eslint/prettier to biome
+
 ## [1.11.0] - 2024-12-19
 
 ### Added

CONTRIBUTING.md

@@ -7,15 +7,26 @@ git clone [email protected]:corentinmusard/otel-cicd-action.git
 cd otel-cicd-action
 ```
 
-Setup precommit hook, install dependencies and run tests:
+Setup precommit hook, install dependencies:
 
 ```sh
 npm run prepare
 npm i
-npm run test
 ```
 
-## Contributing code
+Fill `.env.test` based on `.env.test.example`.
+
+`GH_TOKEN` can be found by running `gh auth token`
+
+## Testing
+
+We use a record/replay octokit client to make testing easier.
+
+`npm run test:record` will record all the request made with a real octokit client.
+
+`npm run test` will replay the recorded requests.
+
+## Pushing code
 
 Be sure to run the following command before pushing code.
 

biome.json

@@ -8,7 +8,8 @@
   "linter": {
     "rules": {
       "complexity": {
-        "useLiteralKeys": "off"
+        "useLiteralKeys": "off",
+        "noExcessiveCognitiveComplexity": "info"
       },
       "performance": {
         "noAccumulatingSpread": "off"
@@ -20,5 +21,10 @@
     "clientKind": "git",
     "useIgnoreFile": true,
     "defaultBranch": "main"
+  },
+  "json": {
+    "parser": {
+      "allowComments": true
+    }
   }
 }