@arundo/edge-agent-types

Edge Agent Types

:mega: If you are looking for How to install latest Arundo Edge Agent, take a look here.

About

This repository contains the Edge Agent Types, which is used heavily by edge-agent and edge-agent-ui. If you want to change some of the types, make sure you link this repository to your project and use the yarn watch script described below.

How Edge Agent Works

If you want to dive into how Edge Agent works, take a look here. #Change this link

Quick start - First time setup FOR DEVELOPERS

You need to do the following,

• Download and install Node LTS.
• Download and install Yarn.

Get started

First, you'll need to install the dependencies by executing

yarn install

A preinstall script exists in package.json that sets git config hooks.Path to ./git/hooks. This is for automatically checking commit messages locally.

This package is used by for instance edge-agent and edge-agent-ui. To be able to use a local version of this package, you need to link this package within the repository that uses this package. First link this repository to your global yarn package repository. Go inside edge-agent-types and run:

yarn link

Then go to the repository you want to start using this local version of the package (for example edge-agent), and run:

yarn link @arundo/edge-agent-types

Remember to build the types. This has to be done each time you change the types, to be able to see the changes in the project you are working on.

yarn compile

You can also put the compiler in watch mode, which will compile whenever you change the code.

yarn watch

Releasing new version

• When creating a new file be sure to add it as an import to the index.ts file in root the same folder. This is needed because edge-agent-types is released as a package to npm and only files imported in index.ts will be compiled.
• Be sure to add tests and run yarn test before committing.
• And don't forget snyk... (yarn snyk test and yarn snyk wizard)
• Create a new branch and a PR into develop
• Create a new PR from develop into master
• Once it's built and released it will be availabble in npm

Committing practices

:warning: This repo uses semantic-release to create new releases. The release version is determined by commit messages and type. Pull request or commits to master trigger new releases. For more info, have a look at our Git guidelines.

To commit use:

yarn commit

If you want to write commit messages by hand be sure to follow Angular commit messages guidlines

Short summary

Prefix

• feat: A new feature
• fix: A bug fix
• docs: Documentation only changes
• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
• refactor: A code change that neither fixes a bug nor adds a feature
• perf: A code change that improves performance
• test: Adding missing or correcting existing tests
• chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

For example: fix(inputModules): better error handling

If you want to use git commit -m "something-something" you must format the commit messages according to the Angular commit message guidlines. A git hook (husky + commitlint) will run on hook type commit-msg, and prevents you from adding faulty commit messages.

If you are having trouble running the git hook delete your hooks folder:

rm -rf .git/hooks

and run:

yarn install --force

How to do releases

If you are looking on how we release the Edge Agent product, have a look here.