New readme (#597)

* new readme * add packages list * update example * add package list generator * update readme and example to match the guide * fix readme urls * update packages list * fix readme * format example * Update README.md Co-authored-by: Feliks Pobiedziński <[email protected]> * fixes for CR * add update packages list action * fixes for CR --------- Co-authored-by: Feliks Pobiedziński <[email protected]>
membraneframework · Sep 26, 2023 · 53598cc · 53598cc
1 parent 6afd4b3
commit 53598cc
Show file tree

Hide file tree

Showing 5 changed files with 627 additions and 21 deletions.
diff --git a/.formatter.exs b/.formatter.exs
@@ -11,7 +11,7 @@ locals_without_parens =
 [
   inputs: [
     "{lib,test,config,benchmark}/**/*.{ex,exs}",
-    "mix.exs"
+    "*.exs"
   ],
   locals_without_parens: locals_without_parens,
   export: [

diff --git a/.github/workflows/update-packages-list.yml b/.github/workflows/update-packages-list.yml
@@ -0,0 +1,28 @@
+name: Update packages list
+on:
+  schedule:
+    - cron: '0 0 1 1-12/1 *' # Run every month
+  workflow_dispatch: {}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Update packages list in README
+    steps:
+      - uses: actions/checkout@v3
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: '26.1'
+          elixir-version: '1.15.6'
+      - name: Update packages list
+        env:
+          GH_TOKEN: ${{ secrets.BOT_TOKEN }}
+        run: |
+          elixir update_packages_list.exs
+          git config user.name 'Membrane Bot'
+          git config user.email '[email protected]'
+          git checkout -B auto-update-packages-list
+          git add README.md
+          git commit -m "auto update packages list in readme" --allow-empty
+          git push -f -u origin auto-update-packages-list
+          gh pr create -B master -H auto-update-packages-list --title 'Auto update packages list' --body ''