Merge pull request #6 from EmilienM/local

use local repo for self testing

Author: EmilienM

.github/workflows/main.yml renamed to .github/workflows/with-defaults.yml

@@ -3,13 +3,13 @@ on:
   - push
 
 jobs:
-  devstack_action_defaults:
+  with_defaults:
     runs-on: ubuntu-latest
     name: A job to deploy devstack with defaults
     steps:
       - uses: actions/checkout@v2
       - id: devstack-action
-        uses: EmilienM/[email protected]
+        uses: ./
       - name: Upload logs artifacts on failure
         if: failure()
         uses: actions/upload-artifact@v2

README.md

@@ -1,3 +1,25 @@
+[![.github/workflows/with-defaults.yml](https://github.com/EmilienM/devstack-action/actions/workflows/with-defaults.yml/badge.svg)](https://github.com/EmilienM/devstack-action/actions/workflows/with-defaults.yml)
+
 # devstack-actions
-Github actions for Devstack
+Github actions which will install OpenStack with devstack.
+
+Example of Github Action step:
+
+With defaults:
+```
+    steps:
+      - name: Deploy devstack
+        uses: EmilienM/[email protected]
+```
 
+With overrides:
+```
+    steps:
+      - name: Deploy devstack
+        uses: EmilienM/[email protected]
+        with:
+          branch: stable/xena
+          conf_overrides:
+            CINDER_ISCSI_HELPER=tgtadm
+          enabled_services: 's-account,s-container,s-object,s-proxy'
+```