ionize

Ionize

Wrapper around ion-connect to manage the asynchronous calls necessary to embed in a CI/CD process

Requirements

Golang Version 1.17 or higher

Installation

Ionize can be installed from source, a binary download, or indirectly within a Docker container.

Go:

go get github.com/ion-channel/ionize
cd $GOPATH/src/github.com/ion-channel/ionize
go build
go install

Binary:

http://github.com/ion-channel/ionize/releases/latest

Docker:

docker pull ionchannel/ionize

Running

Ionize requires a key to authenticate with the Ion Channel API. You can create one inside the Ion Channel console. Once you have the key you can supply it to Ionize with an environment variable.

Running with the native tool:

IONCHANNEL_SECRET_KEY=<secret> ionize help

And within a docker container:

docker run -it -e IONCHANNEL_SECRET_KEY=<secret> ionchannel/ionize help

In addition to the api key you will also need a .ionize.yaml file in the current working directory. The file contains ids for the project in Ion Channel to analyze as well as any configuration needed. An example can be seen here.

Versioning

The project will be versioned in accordance with Semver 2.0.0. See the releases section for the latest version. Until version 1.0.0 the project is considered to be unstable.

License

This project is distributed under the Apache License, Version 2.0. See LICENSE.md for more information.

Updating dependencies with go modules

To update ionic: go get -u github.com/ion-channel/ionic@master && go mod vendor

Example: To update to a specific version: go get -u github.com/someOrg/super_cool_project@v1.0.1

Example: To update to a specific version: go get -u github.com/someOrg/super_cool_project@af044c0995fe

If you get errors use the following at beginning of the commands: GO111MODULE=on GOPRIVATE=github.com/ion-channel

To update the linter requirements (to fix inconsistent vendoring in build): go get -u golang.org/x/lint && go get -u golang.org/x/tools && go mod vendor