sync-mta-version is a utility designed to keep the mta.yaml file in sync with the version defined in package.json.

Table of Contents

• Table of Contents
• Installation
  • Usage
    • Option 1: using as command in the package.json
    • Option 2: using as github workflow
• Contributing
• License
• Authors

Installation

Install sync-mta-version globally:

npm install -g @dxfrontier/sync-mta-version

Usage

| Option | Description | Default | |-------------------------------------|---------------------------------------------------------------------------------------------|-------------------------| | -f, --file <mta> | add the MTA file to be processed for version synchronization with the root package.json version (default: "mta.yaml"). | "mta.yaml" | | -e, --extension [extensions...] | add the MTA extension (mtaext) files to be processed for version synchronization with the root package.json version (multiple files allowed, separated by space). | | | -u, --uiLocation <uiLocation> | add the UI folder to update package.json (version) and manifest.json ("sap.app".applicationVersion.version) properties recursively from the root package.json version (usually is /app). | | | -h, --help | Display help for the command | |

Example:

$ sync-mta-version
$ sync-mta-version -f mta.yaml
$ sync-mta-version -f mta.yaml -e dev.mtaext qa.mtaext production.mtaext
$ sync-mta-version -f mta.yaml -e dev.mtaext qa.mtaext production.mtaext -u /app
$ sync-mta-version -f mta.yaml -u /app

Option 1: using as command in the package.json

1. Add the following script to the scripts section of your package.json:

"scripts": {
  "sync:mta": "sync-mta-version -f mta-yaml"
}

[!IMPORTANT] The command looks for an mta.yaml file in the project root and updates its version to match that of package.json.

2. To synchronize the mta.yaml version with package.json, run:

npm run sync:mta

Option 2: using as github workflow

The example below outlines a workflow that triggers on merging a pull request into main

# This is a workflow which copies the package.json version into the mta.yaml after the `Pull request` was merged
name: Synchronize mta

on:
  pull_request:
    branches:
      - main
    types:
      - closed
  
permissions:
  contents: write
  pull-requests: write

jobs:
  synchronize_mta_version:
    name: Synchronize mta.yaml with the package.json version 
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Install dependencies
        run: npm install

      - name: Sync mta versioning
        run: npx @dxfrontier/sync-mta-version -f mta.yaml

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

Copyright (c) 2024 DXFrontier

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.

Authors

• @sblessing
• @mathiasvkaiz
• @dragolea
• @ABS GmbH team