props

Author: zoeying

.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: "test"
+on:
+  push:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+      with:
+        path: "./"
+
+    - name: get properties
+      id: json_properties
+      uses: ./
+      with: 
+        file_path: 'package.json'
+
+    - run: |
+        echo ${{steps.json_properties.outputs.name}}
+        echo ${{steps.json_properties.outputs.version}}
+        
+    - name: get specified property
+      id: repository_type
+      uses: ./
+      with: 
+        file_path: 'package.json'
+        prop_path: 'repository.type'
+
+    - run: |
+        echo ${{steps.repository_type.outputs.value}}
+

.gitignore

@@ -0,0 +1,20 @@
+# Dependency directory
+node_modules
+
+# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS metadata
+.DS_Store
+Thumbs.db
+
+# Ignore built ts files
+__tests__/runner/*
+lib/**/*
+!dist/**/*.js

LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2021 zoexx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+# github-action-json-file-properties
+
+Read JSON file and set properties to `output` of github action `steps`.
+
+## Usage
+
+Examples:
+
+Get properties
+
+```yaml
+---
+- name: get properties
+  id: json_properties
+  uses: ./
+  with:
+    file_path: "package.json"
+
+- run: |
+    echo ${{steps.json_properties.outputs.name}}
+    echo ${{steps.json_properties.outputs.version}}
+```
+
+Get a specified property **value** with `prop_path`
+
+```yaml
+---
+- name: get specified property
+  id: json_name
+  uses: ./
+  with:
+    file_path: "package.json"
+    prop_path: "repository.type"
+
+- run: |
+    echo ${{steps.get_json_nested_properties.outputs.value}}
+```

action.yml

@@ -0,0 +1,16 @@
+name: "Get Properties From JSON File"
+description: "GitHub Action to load properties from a JSON file."
+author: "zoexx"
+inputs:
+  file_path:
+    required: true
+    description: "path to file"
+  prop_path:
+    required: false
+    description: "e.g.: key1.key2"
+runs:
+  using: "node12"
+  main: "dist/index.js"
+branding:
+  color: "yellow"
+  icon: "fast-forward"