https://github.com/karapetianash/goci

CI pipeline for building, testing, formatting and pushing project to Github.
https://github.com/karapetianash/goci

context mock signal-processing

Last synced: about 1 month ago
JSON representation

CI pipeline for building, testing, formatting and pushing project to Github.

• Host: GitHub
• URL: https://github.com/karapetianash/goci
• Owner: karapetianash
• Created: 2024-04-18T21:00:29.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-27T09:19:46.000Z (8 months ago)
• Last Synced: 2024-04-27T10:26:45.003Z (8 months ago)
• Topics: context, mock, signal-processing
• Language: Go
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Description

This `goci` is a simple, but useful, implementation of a `Continuous Integration (CI)` 

tool for your Go programs. 

A typical `CI pipeline` consists of several automated steps that

continuously ensure a code base or an application is ready to be merged

with some other developer’s code, usually in a shared version control

repository.

### For this example, the CI pipeline consists of:

* Building the program using `go build` to verify if the program structure is

valid.

* Executing tests using `go test` to ensure the program does what it’s

intended to do.

* Executing `gofmt` to ensure the program’s format conforms to the

standards.

* Executing `git push` to push the code to the remote shared Git repository

that hosts the program code.

The `goci` tool accepts only one flag `-p` of type string,

which represents the Go project directory on which to execute the `CI`

pipeline steps.

## Usage

To build the app, run the following command in the root folder:

```

> go build .

```

Above command will generate `goci` file. This name is defined in the `go.mod` file, and it will be the initialized module name.

After that you can run the program using the cmd.\

Example of using the pipeline for a project:

```

> .\goci.exe -p project/directory/

```