docs: Revise README for clarity and structure #103
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: go-ci | |
| on: | |
| push: | |
| tags: | |
| - 'v*' | |
| branches: | |
| - main | |
| - 'feature/**' | |
| - 'fix/**' | |
| - 'refactor/**' | |
| - 'test/**' | |
| - 'docs/**' | |
| - 'chore/**' | |
| pull_request: | |
| jobs: | |
| test-and-lint: | |
| name: test-and-lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/setup-go@v3 | |
| with: | |
| go-version: 1.24.0 | |
| - uses: actions/checkout@v3 | |
| - name: Test | |
| run: make coverage-modular | |
| - name: Codecov | |
| uses: codecov/[email protected] | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: ./cover.out | |
| flags: unittests | |
| verbose: true | |
| fail_ci_if_error: false # Don't fail CI if Codecov upload fails (e.g., rate limit) | |
| # Note: If CODECOV_TOKEN is not set, uploads may be rate-limited (429 error) | |
| # To fix: Go to https://codecov.io/gh/andeya/gust/settings and copy the repository upload token | |
| # Then add it as a secret named CODECOV_TOKEN in GitHub repository settings | |
| - name: golangci-lint | |
| uses: golangci/golangci-lint-action@v3 | |
| with: | |
| # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version | |
| version: latest | |
| # Optional: working directory, useful for monorepos | |
| working-directory: ./ | |
| # Optional: golangci-lint command line arguments. | |
| args: --print-resources-usage --fast --timeout 20m0s --max-same-issues 50 --skip-dirs scripts ./... | |
| # Optional: show only new issues if it's a pull request. The default value is `false`. | |
| # only-new-issues: true | |
| # Optional: if set to true then the all caching functionality will be complete disabled, | |
| # takes precedence over all other caching options. | |
| # skip-cache: true | |
| # Optional: if set to true then the action don't cache or restore ~/go/pkg. | |
| # skip-pkg-cache: true | |
| # Optional: if set to true then the action don't cache or restore ~/.cache/go-build. | |
| # skip-build-cache: true |