get-xml-info

Get Information from XML files to use into your GitHub workflows

Inputs

xml-file

Required The path of the XML file to parse. Default "test.xml".

xpath

Required The xpath of the nodes from which you want to retrieve information. Default "//element".

zero-nodes-action

Optional How to handle finding Zero (0) nodes. Default error.

namespaces

Optional JSON object with namespaces in it

Example usage

uses: mavrosxristoforos/[email protected]
  with:
    xml-file: 'yourfile.xml'
    xpath: '//element'
    namespaces: '{"x": "http://maven.apache.org/POM/4.0.0"}'

Console usage

node dist/index.js -f path/to/xmlfile -p //element

You can also add -d for debug output.

node dist/index.js -f path/to/file.xml -p //element -d

To leverage the zero-nodes-action functionality, use the -z argument:

node dist/index.js -f file.xml -p //version -z warn
node dist/index.js -f file.xml -p //version -z silent

Alternatively, if you are developing the code, you can run npm install, and run the non-compiled index.js version in the root directory.

Attributes

Since version 1.1.0, you can now also read attributes. Example:

//element/@version

Namespaces

Namespaces are currently not supported, so you can use the local-name() XPath function instead. Example:

//*[local-name()='project']/*[local-name()='version']

Outputs

info

The content of the matched nodes. If your XPath matches more than one nodes, the output is an array.

If zero-nodes-action='warn' and no nodes are found, info will contain the message "Zero Nodes Found."

Example usage of output in a workflow

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
    uses: actions/checkout@v1
    - name: Get XML
      id: getxml
      uses: mavrosxristoforos/[email protected]
      with:
        xml-file: 'a-file-here.xml'
        xpath: '//version'
    - name: Create Release
      uses: some-random/release-action@v1
      with:
        artifacts: 'another-file.zip'
        tag: ${{ steps.getxml.outputs.info }}

How to build it

• Run npm install to install all dependencies
• Install vercel/ncc by running this command in your terminal: npm i -g @vercel/ncc
• Compile your index.js file: ncc build index.js --license licenses.txt