INTEGRATION
The "Snowflake Action" is a simple Github Action designed to obtain the Project properties defined within the Extension Manifest File (aka "package.json"). To integrate the "Snowflake Action" within your Github Workflow you need to add the following steps within your Github Workflow File.
- name: Obtained Project Version
uses: ShaidK/Snowflake@v2.1.0
with:
required_property: '<NAME_OF_PROPERTY>'
INPUT
The "Snowflake Action" requires the input parameter required_property
.
This defines the property which is needed to be obtained from Extension
Manifest aka "package.json".
OUTPUT
The "Snowflake Action" will output the property based upon the name of
the property which was requested aka property_<NAME_OF_PROPERTY>
.
For example if the property name
was requested, the output property
will be defined as property_name
.
USAGE
Note: Example Usage of the Snowflake Action
jobs:
obtain_package_json_property:
runs-on: windows-latest
name: Obtained Package JSON Properties
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Obtained Project Version
uses: ShaidK/Snowflake@v2.1.0
with:
required_property: 'version'
- name: Output Project Version
run: echo 'Project Version - ${{ steps.package_version.outputs.property_version }}