-
Notifications
You must be signed in to change notification settings - Fork 154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Move release process to be based off of tagging instead of pushes to main #2141
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
5c11e1f
Move release process to be based off of tagging instead of pushes to …
plorenz 4f833b8
call downstream workflows with version tag
qrkourier 4d3107f
Upate deps and release notes
plorenz 7e448f3
tweak releasing guidance for tag-based
qrkourier 21d7285
correct an error mentioning 'default branch'
qrkourier e9ee792
Merge pull request #2143 from openziti/tweak-releasing-guidance
qrkourier 470dfe0
Update RELEASING.md
qrkourier adb7410
clarify the conditions for promoting downstreams
qrkourier 9fb8f01
Update changelog and deps
plorenz a731c28
Merge remote-tracking branch 'refs/remotes/origin/tag-based-releases'…
plorenz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,257 @@ | ||
| name: release | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - v* | ||
| workflow_dispatch: | ||
|
|
||
| env: | ||
| GOFLAGS: "-trimpath" | ||
| GOX_OUTPUT: "release/{{.Arch}}/{{.OS}}/{{.Dir}}" | ||
| GOX_TEST_OUTPUT: "test/{{.Arch}}/{{.OS}}/bin/{{.Dir}}" | ||
| gh_ci_key: ${{ secrets.GH_CI_KEY }} | ||
| BUILD_NUMBER: ${{ format('{0}-{1}-{2}', github.run_id, github.run_number, github.run_attempt) }} | ||
| ZITI_BASE_VERSION: ${{ vars.ZITI_BASE_VERSION || null }} | ||
|
|
||
| jobs: | ||
| mac-os-build: | ||
| name: Build Mac OS binaries | ||
| # allow fors to opt-out of time-consuming macOS builds | ||
| if: vars.ZITI_SKIP_MACOS_BUILD != 'true' | ||
| runs-on: macos-11 | ||
| steps: | ||
| - name: Git Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: ./go.mod | ||
|
|
||
| - name: Install Ziti CI | ||
| uses: openziti/ziti-ci@v1 | ||
|
|
||
| - name: Build and Test | ||
| shell: bash | ||
| run: | | ||
| go install github.com/mitchellh/gox@latest | ||
| $(go env GOPATH)/bin/gox -ldflags "$($(go env GOPATH)/bin/ziti-ci -q -t go-build-flags)" -cgo -os=darwin -arch=amd64 -output=$GOX_OUTPUT ./... | ||
| $(go env GOPATH)/bin/gox -ldflags "$($(go env GOPATH)/bin/ziti-ci -q -t go-build-flags)" -cgo -os=darwin -arch=arm64 -output=$GOX_OUTPUT ./... | ||
|
|
||
| - name: Upload artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: darwin-release-${{ github.run_id }} | ||
| path: release/ | ||
| retention-days: 5 | ||
|
|
||
| windows-build: | ||
| name: Build Windows binaries | ||
| # allow fors to opt-out of time-consuming Windows builds | ||
| if: vars.ZITI_SKIP_WINDOWS_BUILD != 'true' | ||
| runs-on: windows-2019 | ||
| steps: | ||
| - name: Git Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: ./go.mod | ||
|
|
||
| - name: Install Ziti CI | ||
| uses: openziti/ziti-ci@v1 | ||
|
|
||
| - name: Build and Test | ||
| shell: bash | ||
| run: | | ||
| go install github.com/mitchellh/gox@latest | ||
| $(go env GOPATH)/bin/gox -ldflags "$($(go env GOPATH)/bin/ziti-ci -q -t go-build-flags)" -cgo -os=windows -arch=amd64 -output=$GOX_OUTPUT ./... | ||
|
|
||
| - name: Upload artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: windows-release-${{ github.run_id }} | ||
| path: release/ | ||
| retention-days: 5 | ||
|
|
||
| linux-build: | ||
| name: Build Linux binaries | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - name: Git Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: ./go.mod | ||
|
|
||
| - name: Install Ziti CI | ||
| uses: openziti/ziti-ci@v1 | ||
|
|
||
| - name: Build and Test | ||
| shell: bash | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get -yq install gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf gcc-aarch64-linux-gnu | ||
| $(go env GOPATH)/bin/ziti-ci configure-git | ||
| go install github.com/mitchellh/gox@latest | ||
| $(go env GOPATH)/bin/ziti-ci -t go-build-flags | ||
| $(go env GOPATH)/bin/gox -ldflags "$($(go env GOPATH)/bin/ziti-ci -q -t go-build-flags)" -cgo -os=linux -arch=amd64 -output=$GOX_OUTPUT ./... | ||
| CC=arm-linux-gnueabihf-gcc $(go env GOPATH)/bin/gox -ldflags "$($(go env GOPATH)/bin/ziti-ci -q -t go-build-flags)" -cgo -os=linux -arch=arm -output=$GOX_OUTPUT ./... | ||
| CC=aarch64-linux-gnu-gcc $(go env GOPATH)/bin/gox -ldflags "$($(go env GOPATH)/bin/ziti-ci -q -t go-build-flags)" -cgo -os=linux -arch=arm64 -output=$GOX_OUTPUT ./... | ||
|
|
||
| - name: Upload artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: linux-release-${{ github.run_id }} | ||
| path: release/ | ||
| retention-days: 5 | ||
|
|
||
| tests: | ||
| name: Run Unit and Integration Tests | ||
| runs-on: ubuntu-20.04 | ||
| steps: | ||
| - name: Git Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: ./go.mod | ||
|
|
||
| - name: Install Ziti CI | ||
| uses: openziti/ziti-ci@v1 | ||
|
|
||
| - name: Run Go Quickstart Test | ||
| timeout-minutes: 5 | ||
| shell: bash | ||
| run: | | ||
| go test -v -tags "quickstart automated" ./ziti/cmd/edge/...; | ||
|
|
||
| - name: Run Unit and Integration Tests | ||
| timeout-minutes: 10 | ||
| shell: bash | ||
| run: | | ||
| go test ./... --tags apitests | ||
|
|
||
| publish: | ||
| name: Publish Binaries | ||
| if: ${{ | ||
| !cancelled() | ||
| && (needs.mac-os-build.result == 'success' || needs.mac-os-build.result == 'skipped') | ||
| && (needs.windows-build.result == 'success' || needs.windows-build.result == 'skipped') | ||
| }} | ||
| needs: [ tests, linux-build, mac-os-build, windows-build ] | ||
| runs-on: ubuntu-20.04 | ||
| outputs: | ||
| ZITI_VERSION: ${{ steps.get_version.outputs.ZITI_VERSION }} | ||
| steps: | ||
| - name: Git Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install Go | ||
| uses: actions/setup-go@v5 | ||
| with: | ||
| go-version-file: ./go.mod | ||
|
|
||
| - name: Install Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.7' | ||
|
|
||
| - name: Install Ziti CI | ||
| uses: openziti/ziti-ci@v1 | ||
|
|
||
| - name: Download linux release artifact | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: linux-release-${{ github.run_id }} | ||
| path: release/ | ||
|
|
||
| - name: Download darwin release artifact | ||
| if: needs.mac-os-build.result == 'success' | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: darwin-release-${{ github.run_id }} | ||
| path: release/ | ||
|
|
||
| - name: Download windows release artifact | ||
| if: needs.windows-build.result == 'success' | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: windows-release-${{ github.run_id }} | ||
| path: release/ | ||
|
|
||
| - name: List downloaded release artifacts | ||
| shell: bash | ||
| run: | | ||
| ls -lAhR release/ | ||
|
|
||
| - name: Restore execute filemode on macOS and Linux release artifacts before publishing | ||
| shell: bash | ||
| run: | | ||
| find ./release \ | ||
| -type f \ | ||
| -print0 \ | ||
| -path "./release/*/darwin/ziti" \ | ||
| -o \ | ||
| -path "./release/*/linux/ziti" \ | ||
| | xargs -0 chmod -c +x | ||
|
|
||
| - name: Publish GitHub Release | ||
| # forks need to run this step with their own GPG key because ziti-ci creates the GH release | ||
| if: env.ziti_ci_gpg_key_id != null && startsWith(github.ref, 'refs/tags/v') | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| ziti_ci_gpg_key: ${{ secrets.ZITI_CI_GPG_KEY }} | ||
| ziti_ci_gpg_key_id: ${{ secrets.ZITI_CI_GPG_KEY_ID }} | ||
| shell: bash | ||
| run: | | ||
| $(go env GOPATH)/bin/ziti-ci configure-git | ||
| $(go env GOPATH)/bin/ziti-ci publish-to-github -t --prerelease --archive-base "" | ||
|
|
||
| # only ziti-ci computed version for release branches and {version}-{run_id} for non-release branches | ||
| - name: Compute the Ziti Version String used for Linux Packages and Container Image Tags | ||
| id: get_version | ||
| shell: bash | ||
| run: | | ||
| # drop the leading 'v', if any | ||
| ZITI_VERSION=${GITHUB_REF_NAME#v} | ||
| echo ZITI_VERSION="${ZITI_VERSION}" | tee -a $GITHUB_OUTPUT | ||
|
|
||
| call-publish-docker-images: | ||
| # - !cancelled() allows evaluating further conditional expressions even if | ||
| # needed jobs were skipped | ||
| if: ${{ !cancelled() && needs.publish.result == 'success' }} | ||
| name: Publish Release Docker Images | ||
| needs: publish | ||
| uses: ./.github/workflows/publish-docker-images.yml | ||
| secrets: inherit | ||
| with: | ||
| ziti-tag: ${{ needs.publish.outputs.ZITI_VERSION }} | ||
|
|
||
| # call on release-next and release branches to publish linux packages to | ||
| # "testing" and "release" package repos in Artifactory | ||
| call-publish-linux-packages: | ||
| # - !cancelled() allows evaluating further conditional expressions even if | ||
| # needed jobs were skipped | ||
| if: ${{ !cancelled() && needs.publish.result == 'success' }} | ||
| name: Publish Linux Packages | ||
| needs: publish | ||
| uses: ./.github/workflows/publish-linux-packages.yml | ||
| secrets: inherit | ||
| with: | ||
| ziti-version: ${{ needs.publish.outputs.ZITI_VERSION }} | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not release trigger?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tag creates the release, marked as pre-release. Could do it the other way, but it's even more manual
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
don't we want release to be a deliberate manual process?
either way is fine
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a deliberate manual process, it's just one done via tag, push tag, rather than through the GH UI.