-
Notifications
You must be signed in to change notification settings - Fork 3
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
Setup env-loader CI/CD and dev tooling #284
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b090543
Setup env-loader CI/CD and dev tooling
fheinecke fef1952
Fix missing local dev tools
fheinecke 0494689
Move reusable workflows under .github/workflows
fheinecke 58a81d4
symlink reusable workflows
fheinecke d06b962
Bump linter for 1.23 compat
fheinecke c7023ae
set working dir
fheinecke e2ae333
fix building for windows arm64 instead of amd64
fheinecke f0866e4
Fix image builds
fheinecke 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 |
|---|---|---|
|
|
@@ -4,50 +4,11 @@ name: Changelog generator CI | |
| on: | ||
| pull_request: | ||
|
|
||
| env: | ||
| TOOL_DIRECTORY: tools/changelog | ||
|
|
||
| jobs: | ||
| test: | ||
| name: Run tests | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| # Determine if tests should run | ||
| # This is a monorepo and GH checks cannot be required for only specific | ||
| # paths, so this is required instead of a trigger `paths` filter. | ||
| - name: Check if relavent files have changed | ||
| id: changes | ||
| uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 | ||
| with: | ||
| filters: | | ||
| tool: | ||
| - 'tools/changelog/**' | ||
| - '.github/workflows/changelog-ci.yaml' | ||
|
|
||
| # Setup | ||
| - name: Checkout repository | ||
| if: steps.changes.outputs.tool == 'true' | ||
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
| - name: Setup Go | ||
| if: steps.changes.outputs.tool == 'true' | ||
| uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2 | ||
| with: | ||
| go-version-file: "${{ env.TOOL_DIRECTORY }}/go.mod" | ||
|
|
||
| # Linting | ||
| - name: Install golangci-lint | ||
| if: steps.changes.outputs.tool == 'true' | ||
| run: go install github.com/golangci/golangci-lint/cmd/[email protected] | ||
| - name: Lint | ||
| if: steps.changes.outputs.tool == 'true' | ||
| working-directory: ${{ env.TOOL_DIRECTORY }} | ||
| run: make lint | ||
|
|
||
| # Tests | ||
| - name: Install gotestsum | ||
| if: steps.changes.outputs.tool == 'true' | ||
| run: go install gotest.tools/[email protected] | ||
| - name: Run tests | ||
| if: steps.changes.outputs.tool == 'true' | ||
| working-directory: ${{ env.TOOL_DIRECTORY }} | ||
| run: make test | ||
| release: | ||
| uses: ./.github/workflows/reusable-ci.yaml | ||
| permissions: | ||
| contents: write | ||
| packages: write | ||
| with: | ||
| tool-directory: ./tools/changelog | ||
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,25 @@ | ||
| --- | ||
| name: Environment value loader CD | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| paths: | ||
| - tools/env-loader | ||
| tags: | ||
| - "tools/env-loader/v[0-9]+.[0-9]+.[0-9]+**" | ||
| pull_request: | ||
| paths: | ||
| - tools/env-loader/workflows/cd.yaml | ||
| - .github/workflows/env-loader-cd.yaml | ||
| - .github/workflows/reusable-cd.yaml | ||
|
|
||
| jobs: | ||
| release: | ||
| uses: ./.github/workflows/reusable-cd.yaml | ||
| permissions: | ||
| contents: write | ||
| packages: write | ||
| with: | ||
| tool-directory: ./tools/env-loader |
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,14 @@ | ||
| --- | ||
| name: Environment value loader CI | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| release: | ||
| uses: ./.github/workflows/reusable-ci.yaml | ||
| permissions: | ||
| contents: write | ||
| packages: write | ||
| with: | ||
| tool-directory: ./tools/env-loader | ||
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,137 @@ | ||
| --- | ||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| tool-directory: | ||
| type: string | ||
| description: Path to the tool's directory, relative to repo root | ||
| dockerfile-path: | ||
| type: string | ||
| description: Path to the tool's dockerfile, relative to repo root | ||
| default: ./tools/repo-release-tooling/Dockerfile | ||
|
|
||
| jobs: | ||
| release: | ||
| name: Release | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write # Needed to create the release | ||
| packages: write # Needed to upload the images to GHCR | ||
| steps: | ||
| # Setup | ||
| - name: Checkout repository | ||
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
| - name: Get the name of the tool | ||
| working-directory: ${{ inputs.tool-directory }} | ||
| run: set -e; echo "TOOL_NAME=$(make tool-name)" >> "${GITHUB_ENV}" | ||
| - name: Create event-specific values | ||
| id: setup | ||
| run: | | ||
| # Determine if the workflow was triggered via a push to main or a tag | ||
| # and get the version based off of that | ||
| if [[ "${GITHUB_REF}" =~ refs/tags/.* ]]; then | ||
| # Transforms tag refs like refs/tags/tools/${TOOL_NAME}/v1.2.3 into v1.2.3 | ||
| echo "version=${GITHUB_REF#refs/tags/tools/${TOOL_NAME}}" >> "${GITHUB_OUTPUT}" | ||
|
|
||
| # Eventually the parse-version action from the teleport.e repo | ||
| # should move into this repo and replace this logic | ||
| echo "should-release=true" >> "${GITHUB_OUTPUT}" | ||
|
|
||
| # Any '-' character means in a tag ref means that it is a prerelease | ||
| if [[ "${GITHUB_REF}" == *-* ]]; then | ||
| echo "is-prerelease=true" >> "${GITHUB_OUTPUT}" | ||
| fi | ||
| fi | ||
|
|
||
| # Build the binaries | ||
| - name: Setup Go | ||
| uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2 | ||
| with: | ||
| go-version-file: '${{ inputs.tool-directory }}/go.mod' | ||
| cache-dependency-path: '${{ inputs.tool-directory }}/go.sum' | ||
|
|
||
| - name: Build the project | ||
| working-directory: ${{ inputs.tool-directory }} | ||
| run: | | ||
| make tarball OS=linux ARCH=amd64 | ||
| make tarball OS=linux ARCH=arm64 | ||
| make tarball OS=darwin ARCH=amd64 | ||
| make tarball OS=darwin ARCH=arm64 | ||
| make tarball OS=windows ARCH=amd64 | ||
|
|
||
| # Build and push the image | ||
| - name: Install docker buildx | ||
| uses: docker/setup-buildx-action@4fd812986e6c8c2a69e18311145f9371337f27d4 # v3.4.0 | ||
|
|
||
| - name: Login to GitHub Container Registry | ||
| id: login-ghcr | ||
| uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0 | ||
| with: | ||
| registry: ghcr.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| # TODO move this to `make container-image` or similar. | ||
| # Using these to actions for now because they greatly reduce the amount | ||
| # of in-house logic required | ||
| - name: Prepare container image labels and tags | ||
| id: meta | ||
| uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1 | ||
| with: | ||
| images: | | ||
| ghcr.io/${{ github.repository_owner }}/${{ env.TOOL_NAME }} | ||
| flavor: | | ||
| latest=false | ||
| # Enable sha tag on branch push events and pull requests. | ||
| # Enable semver tags on tag push events, but don't overwrite major/minor tags for prereleases. | ||
| # Semver tags won't be generated except upon tag events. | ||
| tags: | | ||
| type=sha,prefix=v0.0.0-{{branch}}-,enable=${{ startsWith(github.ref, 'refs/heads/') }} | ||
| type=sha,prefix=v0.0.0-{{base_ref}}-,enable=${{ github.event_name == 'pull_request' }} | ||
| type=semver,pattern={{major}},value=${{ steps.setup.outputs.version }},enable=${{ steps.setup.outputs.is-prerelease != 'true' }} | ||
| type=semver,pattern={{major}}.{{minor}},value=${{ steps.setup.outputs.version }},enable=${{ steps.setup.outputs.is-prerelease != 'true' }} | ||
| type=semver,pattern={{version}},value=${{ steps.setup.outputs.version }} | ||
|
|
||
| - name: Build the container image and push | ||
| uses: docker/build-push-action@1ca370b3a9802c92e886402e0dd88098a2533b12 # v6.4.1 | ||
| with: | ||
| context: ${{ inputs.tool-directory }} | ||
| file: ${{ inputs.dockerfile-path }} | ||
| build-args: TOOL_NAME=${{ env.TOOL_NAME }} | ||
| push: true | ||
| tags: ${{ steps.meta.outputs.tags }} | ||
| labels: ${{ steps.meta.outputs.labels }} | ||
| annotations: ${{ steps.meta.outputs.annotations }} | ||
| cache-from: type=gha | ||
| cache-to: type=gha,mode=max | ||
| platforms: | | ||
| linux/amd64 | ||
| linux/arm64 | ||
| provenance: true | ||
| sbom: true | ||
|
|
||
| # File a new release with the tarballs attached | ||
| - name: Create a new GitHub release | ||
| if: ${{ steps.setup.outputs.should-release == 'true' }} | ||
| working-directory: ${{ inputs.tool-directory }} | ||
| env: | ||
| VERSION: ${{ steps.setup.outputs.version }} | ||
| IS_PRERELEASE: ${{ steps.setup.outputs.is-prerelease }} | ||
| run: | | ||
| if [[ "${IS_PRERELEASE}" == 'true' ]]; then | ||
| EXTRA_FLAGS=("--prerelease") | ||
| else | ||
| EXTRA_FLAGS=("--latest") | ||
| fi | ||
|
|
||
| readarray -d '' RELEASE_TARBALLS < <( | ||
| find . -name '*.tar.gz' -print0 | ||
| ) | ||
|
|
||
| echo "Creating a release for ${VERSION} with files:" | ||
| ls -lh "${RELEASE_TARBALLS[@]}" | ||
|
|
||
| gh release create --title "${TOOL_NAME} ${VERSION}" --verify-tag \ | ||
| --generate-notes "${EXTRA_FLAGS[@]}" "${GITHUB_REF_NAME}" \ | ||
| "${RELEASE_TARBALLS[@]}" | ||
|
|
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.
I understand release workflows being separate but for CI can we simplify and just have one workflow that executes all tests? Right now tools may be nicely separated but what if they say use a shared library and it gets modified, this sort of separation will just add headache later. Let's just have a single "unit tests" workflow that runs all Go tests.
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.
Can you clarify what kind of issue this will cause? A large portion of this RFD and the structure it introduced was to reduce headaches and problems introduced by coupling projects together.