Skip to content

Commit

Permalink
1. Fix README.md
Browse files Browse the repository at this point in the history
2. Remove go_install ci
  • Loading branch information
iasergunin committed Nov 10, 2023
1 parent 4b3b77a commit a695682
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 14 deletions.
11 changes: 0 additions & 11 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,6 @@ env:
GOLANGCI_LINT_VERSION: v1.54.0

jobs:
go_install:
runs-on: ubuntu-latest
steps:
- uses: rlespinasse/[email protected]
- uses: actions/setup-go@v4
with:
go-version: ${{ env.GO_VERSION }}
- run: cd /tmp && go install github.com/maranqz/go-factory-lint/cmd/go-factory-lint@${{ env.version }} && go-factory-lint -h
env:
version: ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA || env.GITHUB_REF_SLUG }}

lint:
runs-on: ubuntu-latest
steps:
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Factory linter

[![CI](https://github.com/maranqz/go-factory-lint/actions/workflows/ci.yml/badge.svg)](https://github.com/maranqz/go-factory-lint/actions/workflows/ci.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/maranqz/go-factory-lint)](https://goreportcard.com/report/github.com/maranqz/go-factory-lint?dummy=unused)
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)

The linter checks that the Structes are created by the Factory, and not directly.
The checking helps to provide invariants without exclusion.
Validation helps you avoid losing the creation of invalid object.
Expand All @@ -9,9 +13,7 @@ Validation helps you avoid losing the creation of invalid object.

Installation

go install github.com/maranqz/go-factory-lint@latest

Run
go install github.com/maranqz/go-factory-lint/cmd/go-factory-lint@latest

### Options

Expand Down

0 comments on commit a695682

Please sign in to comment.