Update RELEASING.md to obtain steps to verify the changes for contrib
#12368
Workflow file for this run
This file contains 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: ci | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| env: | |
| # Path to where test results will be saved. | |
| TEST_RESULTS: /tmp/test-results | |
| # Default version of Go to use by CI workflows. This should be the latest | |
| # release of Go; developers likely use the latest release in development and | |
| # we want to catch any bugs (e.g. lint errors, race detection) with this | |
| # release before they are merged. The Go compatibility guarantees ensure | |
| # backwards compatibility with the previous two minor releases and we | |
| # explicitly test our code for these versions so keeping this at prior | |
| # versions does not add value. | |
| DEFAULT_GO_VERSION: "~1.22.3" | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 ## Needed for "Set internal/tools/go.mod timestamp" step. | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.DEFAULT_GO_VERSION }} | |
| check-latest: true | |
| cache-dependency-path: "**/go.sum" | |
| - name: Tools cache | |
| uses: actions/cache@v4 | |
| env: | |
| cache-name: go-tools-cache | |
| with: | |
| path: .tools | |
| key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('./internal/tools/**') }} | |
| # The step below is needed to not rebuild all the build tools. | |
| - name: Set internal/tools/go.mod timestamp | |
| run: | | |
| filename="internal/tools/go.mod" | |
| unixtime=$(git log -1 --format="%at" -- "${filename}") | |
| touchtime=$(date -d @$unixtime +'%Y%m%d%H%M.%S') | |
| touch -t ${touchtime} "${filename}" | |
| ls -la --time-style=full-iso "${filename}" | |
| - name: Generate | |
| run: make generate | |
| - name: Run linters | |
| run: make dependabot-check license-check lint vanity-import-check verify-readmes | |
| - name: Build | |
| run: make build | |
| - name: Check clean repository | |
| run: make check-clean-work-tree | |
| test-bench: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| - name: Setup Environment | |
| run: | | |
| echo "GOPATH=$(go env GOPATH)" >> $GITHUB_ENV | |
| echo "$(go env GOPATH)/bin" >> $GITHUB_PATH | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.DEFAULT_GO_VERSION }} | |
| cache-dependency-path: "**/go.sum" | |
| - name: Run benchmarks to check functionality | |
| run: make test-bench | |
| test-race: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.DEFAULT_GO_VERSION }} | |
| check-latest: true | |
| cache-dependency-path: "**/go.sum" | |
| - name: Run tests with race detector | |
| run: make test-race | |
| test-coverage: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Repo | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.DEFAULT_GO_VERSION }} | |
| check-latest: true | |
| cache-dependency-path: "**/go.sum" | |
| - name: Run coverage tests | |
| run: | | |
| make test-coverage | |
| mkdir $TEST_RESULTS | |
| cp coverage.out $TEST_RESULTS | |
| cp coverage.txt $TEST_RESULTS | |
| cp coverage.html $TEST_RESULTS | |
| - name: Upload coverage report | |
| uses: codecov/codecov-action@v4.3.1 | |
| with: | |
| file: ./coverage.txt | |
| fail_ci_if_error: true | |
| verbose: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| - name: Store coverage test output | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: opentelemetry-go-test-output | |
| path: ${{ env.TEST_RESULTS }} | |
| compatibility-test: | |
| strategy: | |
| matrix: | |
| go-version: ["~1.22.3", "~1.21.10"] | |
| platform: | |
| - os: ubuntu-latest | |
| arch: "386" | |
| - os: ubuntu-latest | |
| arch: amd64 | |
| - os: macos-latest | |
| arch: amd64 | |
| - os: windows-latest | |
| arch: "386" | |
| - os: windows-latest | |
| arch: amd64 | |
| # ARM64 compatibility tests are using actuated runners | |
| # See https://github.com/open-telemetry/community/blob/main/docs/using-actuated.md | |
| - os: actuated-arm64-2cpu-8gb | |
| arch: arm64 | |
| runs-on: ${{ matrix.platform.os }} | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ matrix.go-version }} | |
| check-latest: true | |
| cache-dependency-path: "**/go.sum" | |
| - name: Run tests | |
| env: | |
| GOARCH: ${{ matrix.platform.arch }} | |
| run: make test-short | |
| test-compatibility: | |
| runs-on: ubuntu-latest | |
| needs: [compatibility-test] | |
| steps: | |
| - name: Test if compatibility-test passed | |
| run: | | |
| echo ${{ needs.compatibility-test.result }} | |
| test ${{ needs.compatibility-test.result }} == "success" |