README.md

ci-action

Continious Integration action for go- and node- projects

• Reject ".*" folders (except ignore folders)
• For sources, except ignore and first comments which include DO NOT EDIT:
  • Reject sources which do not have "Copyright" word in first comment
  • Reject sources which have LICENSE word in first comment but LICENSE file does not exist
• Reject go.mod with local replaces
• For Go projects
  • Run go build f./... and go test ./...
• For Node.js projects
  • Run npm install, npm run build --if-present and npm test
• Publish Release (only for "master" branch if publish-asset property is set)
  • The deployer.url file must be present in the root of the repository

Usage

- uses: untillpro/ci-action@master
  with:
    # Folders and files that will be ignored when checking (comma separated)
    ignore: ''

    # The name of the organization(s) on GitHub containing private repositories (comma separated)
    organization: 'untillpro'

    # Auth token used to fetch dependencies from private repositories
    token: ''

    # Codecov token
    codecov-token: ''

    # Codecov: use Go Race Detector
    codecov-go-race: true

    # File / dir name to publish
    publish-asset: ''

    # Auth token used to publish
    publish-token: ${{ github.token }}

    # Number of kept releases (0 - all)
    publish-keep: 8

    # Repository name with owner. For example, untillpro/ci-action
    repository: ${{ github.repository }}

    # Only for go-projects: execute `go mod tidy`
    run-mod-tidy: true

    # Main branch name
    main-branch: 'main'

    # Do not check the copyright in first comments of source code
    ignore-copyright: false

    # Test only in folder
    test-folder: ''

    # Short tests 
    short-test: false

    # Stop tests 
    stop-test: false    

    #Command to build project
    build-cmd: ''	

Outputs

In case of publish release:

• release_id: The ID of the created Release
• release_name: The name (version) of the created Release
• release_html_url: The URL users can navigate to in order to view the release
• release_upload_url: The URL for uploading assets to the release
• asset_browser_download_url: The URL users can navigate to in order to download the uploaded asset

Scenarios

Creaing CODECOV_TOKEN

• Go to apropriate codecov resource, e.g. https://codecov.io/gh/untillpro/ci-action
• Copy token from there
• Use it for CODECOV_TOKEN secret, say https://github.com/untillpro/ci-action/settings/secrets

Go project

• If private modules are used:
  • Create personal access token
    • See also
  • Create secret with the received token named "REPOREADING_TOKEN"
• For automatic uploading reports to [Codecov] Codecov
  • Create secret with Codecov token named "CODECOV_TOKEN"
• Create action workflow "ci.yml" with the following contents:

name: CI-Go
on: [push, pull_request_target]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Set up Go 1.17
      uses: actions/setup-go@v1
      with:
        go-version: 1.17
    - name: Checkout
      uses: actions/checkout@v2
    - name: Cache Go - Modules
      uses: actions/cache@v1
      with:
        path: ~/go/pkg/mod
        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
        restore-keys: |
          ${{ runner.os }}-go-
    - name: CI
      uses: untillpro/ci-action@master
      with:
        token: ${{ secrets.REPOREADING_TOKEN }}
        codecov-token: ${{ secrets.CODECOV_TOKEN }}

Node.js project

• For automatic uploading reports to [Codecov] Codecov
  • Create secret with Codecov token named "CODECOV_TOKEN"
• Create action workflow "ci.yml" with the following contents:

name: CI-Node.js
on: [push,  pull_request_target]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Set up Node.js 20.x
      uses: actions/setup-node@v1
      with:
        node-version: '20.x'
    - name: Checkout
      uses: actions/checkout@v2
    - name: Cache Node - npm
      uses: actions/cache@v1
      with:
        path: ~/.npm
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-
    - name: CI
      uses: untillpro/ci-action@master
      with:
        codecov-token: ${{ secrets.CODECOV_TOKEN }}

Development

Install the dependencies

npm install

Run the tests

npm test

Run package

npm run package

License

The scripts and documentation in this project are released under the MIT License