Skip to main content

Deployment

Once your widget is fully developed and tested, it's time to release it to production. This guide covers the complete deployment process, from versioning your changes using semantic commits to creating merge requests and understanding how the automated pipeline deploys your widget to the platform.

Table of Contents​

  1. Semantic Versioning
  2. Creating Merge Request
  3. Pipeline and Deployment

Semantic Versioning​

Reference:

Commit Types​

PrefixRelease TypeVersion BumpExample
feat:Minor1.x.0feat: add export feature
fix:Patch1.0.xfix: resolve data loading issue
docs:Patch1.0.xdocs: update README
style:Patch1.0.xstyle: format code
refactor:Patch1.0.xrefactor: improve performance
perf:Patch1.0.xperf: optimize query
test:Patch1.0.xtest: add unit tests
chore:Patch1.0.xchore: update dependencies
feat!: or BREAKING CHANGE:Majorx.0.0feat!: redesign API

Breaking Changes​

# Option 1: Use ! after type
git commit -m "feat!: redesign KPI API TICKET-123"

# Option 2: Use BREAKING CHANGE in body
git commit -m "feat: redesign KPI API TICKET-123

BREAKING CHANGE: KPI API endpoint changed from /kpi to /metrics/kpi
"

Creating Merge Request​

Reference:

Branch Naming Convention​

<type>/<project-key>-<ticket-number>-<description>

Examples:
feat/ACME-123-add-export-feature
fix/ACME-456-resolve-loading-issue
docs/ACME-789-update-readme

Create Branch and Commit​

# Create feature branch
git checkout -b feat/ACME-123-add-export-feature

# Make changes
# ... edit files ...

# Stage changes
git add -A

# Commit with semantic format
git commit -m "feat: add export feature for KPI data ACME-123"

# Push to remote
git push --set-upstream origin feat/ACME-123-add-export-feature

MR Title Format​

<type>: <project-key>-<ticket-number> <description>

Examples:
feat: ACME-123 add export feature
fix: ACME-456 resolve data loading issue

MR Template​

## General

Brief description of changes

## Affected features

- Feature 1
- Feature 2

## Testing

- [ ] Unit tests added/updated
- [ ] Manual testing completed
- [ ] Accessibility tested

## Remarks

Any additional notes

## Breaking Changes (if applicable)

Description of breaking changes and migration guide

Create MR via GitLab UI​

  1. Go to GitLab → Merge Requests → New Merge Request
  2. Select source branch (your feature branch)
  3. Select target branch (usually master or main)
  4. Fill in MR details
  5. Check "Squash commits" option
  6. Create Merge Request

Pipeline and Deployment​

When MR is merged:

  1. semantic-release analyzes commits
  2. Determines version bump (major/minor/patch)
  3. Updates package.json version
  4. Creates Git tag
  5. Generates changelog
  6. CI/CD pipeline builds widget
  7. Uploads to the portal via the Micro App Library automatically

GitLab CI Configuration​

.gitlab-ci.yml (auto-configured by template):

include:
  - project: "gitlab/devops"
    file: "/CI/Node_Widgets.yml"

Verify Deployment​

After pipeline completes:

  1. Check the Micro App Library for new version
  2. Verify widget appears in platform
  3. Test widget in development environment
  4. Review Widget Version Control settings

Next Steps​

Want to add advanced features? Continue to: Advanced Features →