Compare commits

..

No commits in common. "main" and "fix-mv" have entirely different histories.
main ... fix-mv

6 changed files with 39 additions and 135 deletions

View File

@ -1,23 +0,0 @@
---
version: 2
updates:
- package-ecosystem: gomod
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 10
groups:
all:
update-types:
- "patch"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 10
groups:
all:
update-types:
- "minor"
- "patch"

View File

@ -1,55 +0,0 @@
name: ci
on:
pull_request:
jobs:
test-ko-action:
runs-on: ubuntu-latest
steps:
- uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
with:
go-version: '1.22'
check-latest: 'true'
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
# Minimal publish
- uses: ./
- run: ko publish --bare ./
if: ${{ github.event_name == 'pull_request' }}
env:
KO_DOCKER_REPO: ko.local
- name: Install old release
uses: ./
with:
version: v0.8.0
- name: Check installed version
run: ko version | grep 0.8.0
- name: Install from tip
uses: ./
with:
version: tip
- name: Check installed version (tip)
run: |
sudo rm /usr/local/bin/ko # Uninstall previous versions.
ko version
# If KO_DOCKER_REPO is set during setup, it's set for future steps.
- name: Pre-set KO_DOCKER_REPO
uses: ./
env:
KO_DOCKER_REPO: already-set
- name: Check pre-set KO_DOCKER_REPO
run: |
if [[ "${KO_DOCKER_REPO}" != "already-set" ]]; then
echo "${KO_DOCKER_REPO} != already-set"
exit 1
fi

View File

@ -2,47 +2,37 @@ name: Use Action
on:
push:
branches:
- 'main'
branches: ['main']
jobs:
use-action:
name: Use Action
strategy:
matrix:
platform:
- ubuntu-latest
- macos-latest
platform: [ubuntu-latest, macos-latest]
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
- uses: actions/setup-go@v2
with:
go-version: '1.22'
check-latest: 'true'
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
go-version: 1.16
- uses: actions/checkout@v2
# Minimal publish
- uses: ko-build/setup-ko@main
- uses: imjasonh/setup-ko@main
- run: ko publish --bare ./
- name: Install old release
uses: ko-build/setup-ko@main
uses: imjasonh/setup-ko@main
with:
version: v0.8.0
- name: Check installed version
run: ko version | grep 0.8.0
- name: Install from tip
uses: ko-build/setup-ko@main
uses: imjasonh/setup-ko@main
with:
version: tip
- name: Check installed version (tip)
run: |
sudo rm /usr/local/bin/ko # Uninstall previous versions.
@ -50,10 +40,9 @@ jobs:
# If KO_DOCKER_REPO is set during setup, it's set for future steps.
- name: Pre-set KO_DOCKER_REPO
uses: ko-build/setup-ko@main
uses: imjasonh/setup-ko@main
env:
KO_DOCKER_REPO: already-set
- name: Check pre-set KO_DOCKER_REPO
run: |
if [[ "${KO_DOCKER_REPO}" != "already-set" ]]; then

View File

@ -1,10 +1,6 @@
# GitHub Action to install and setup [`ko`](https://github.com/ko-build/ko)
# GitHub Action to install and setup [`ko`](https://github.com/google/ko)
[![Build](https://github.com/ko-build/setup-ko/actions/workflows/use-action.yaml/badge.svg)](https://github.com/ko-build/setup-ko/actions/workflows/use-action.yaml)
> :warning: Note: `ko` recently [moved to its own GitHub org](https://github.com/ko-build/ko/issues/791), which broke `setup-ko@v0.5` if the `ko` version wasn't specified.
>
> To fix this, either upgrade to [`setup-ko@v0.6`](https://github.com/ko-build/setup-ko/releases/tag/v0.6) or specify `version`
[![Build](https://github.com/imjasonh/setup-ko/actions/workflows/use-action.yaml/badge.svg)](https://github.com/imjasonh/setup-ko/actions/workflows/use-action.yaml)
## Example usage
@ -20,63 +16,63 @@ jobs:
name: Publish
runs-on: ubuntu-latest
steps:
- uses: actions/setup-go@v4
- uses: actions/setup-go@v2
with:
go-version: '1.20.x'
- uses: actions/checkout@v3
go-version: 1.15
- uses: actions/checkout@v2
- uses: ko-build/setup-ko@v0.6
- run: ko build
- uses: imjasonh/setup-ko@v0.4
- run: ko publish ./
```
_That's it!_ This workflow will build and publish your code to [GitHub Container Regsitry](https://ghcr.io).
By default, the action sets `KO_DOCKER_REPO=ghcr.io/[owner]/[repo]` for all subsequent steps, and uses the `${{ github.token }}` to authorize pushes to GHCR.
See [documentation for `ko`](https://ko.build/configuration/) to learn more about configuring `ko`.
See [documentation for `ko`](https://github.com/google/ko#configuration) to learn more about configuring `ko`.
The action works on Linux and macOS [runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners).
If you'd like support for Windows runners, [let us know](https://github.com/ko-build/setup-ko/issues/new)!
The action works on Linux and macOS [runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners). If you'd like support for Windows runners, [let me know](https://github.com/imjasonh/setup-ko/issues/new).
### Select `ko` version to install
By default, `ko-build/setup-ko` installs the [latest released version of `ko`](https://github.com/ko-build/ko/releases).
By default, `imjasonh/setup-ko` installs the [latest released version of `ko`](https://github.com/google/ko/releases).
You can select a version with the `version` parameter:
```yaml
- uses: ko-build/setup-ko@v0.6
- uses: imjasonh/setup-ko@v0.4
with:
version: v0.14.1
version: v0.8.0
```
To build and install `ko` from source using `go install`, specify `version: tip`.
### Pushing to other registries
By default, `ko-build/setup-ko` configures `ko` to push images to [GitHub Container Registry](https://ghcr.io), but you can configure it to push to other registries as well.
By default, `imjasonh/setup-ko` configures `ko` to push images to [GitHub Container Registry](https://ghcr.io), but you can configure it to push to other registries as well.
If `KO_DOCKER_REPO` is already set when `setup-ko` runs, it will skip logging in to ghcr.io and will propagate `KO_DOCKER_REPO` for subsequent steps.
To do this, you should provide credentials to authorize the push.
You can use [encrypted secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) to store the authorization token, and pass it to `ko login` before pushing:
```yaml
```
steps:
...
- uses: ko-build/setup-ko@v0.6
- uses: imjasonh/setup-ko@v0.4
env:
KO_DOCKER_REPO: my.registry/my-repo
- env:
auth_token: ${{ secrets.auth_token }}
run: |
echo "${auth_token}" | ko login https://my.registry --username my-username --password-stdin
ko build
ko publish ./
```
### Release Integration
In addition to publishing images, `ko` can produce YAML files containing references to built images, using [`ko resolve`](https://ko.build/features/k8s)
In addition to publishing images, `ko` can produce YAML files containing references to built images, using [`ko resolve`](https://github.com/google/ko#kubernetes-integration)
With this action, you can use `ko resolve` to produce output YAML that you then attach to a GitHub Release using the [GitHub CLI](https://cli.github.com).
For example:
@ -86,19 +82,18 @@ name: Publish Release YAML
on:
release:
types:
- 'created'
types: ['created']
jobs:
publish-release-yaml:
name: Publish Release YAML
runs-on: ubuntu-latest
steps:
- uses: actions/setup-go@v4
- uses: actions/setup-go@v2
with:
go-version: '1.20'
- uses: actions/checkout@v3
- uses: ko-build/setup-ko@v0.6
go-version: 1.15
- uses: actions/checkout@v2
- uses: imjasonh/setup-ko@v0.4
- name: Generate and upload release.yaml
env:
@ -111,6 +106,6 @@ jobs:
### A note on versioning
The `@v0.X` in the `uses` statement refers to the version _of the action definition in this repo._
The `@v0.4` in the `uses` statement refers to the version _of the action definition in this repo._
Regardless of what version of the action definition you use, `ko-build/setup-ko` will install the latest released version of `ko` unless otherwise specified with `version:`.
Regardless of what version of the action definition you use, `imjasonh/setup-ko` will install the latest released version of `ko` unless otherwise specified with `version:`.

View File

@ -5,7 +5,7 @@ branding:
color: green
inputs:
version:
description: 'Version of ko to install (tip, latest-release, v0.14.1, etc.)'
description: 'Version of ko to install (tip, latest-release, v0.8.2, etc.)'
required: true
default: 'latest-release'
runs:
@ -50,8 +50,6 @@ runs:
echo "${{ github.token }}" | ko login ghcr.io --username "dummy" --password-stdin
# Set KO_DOCKER_REPO for future steps.
# We need to get the repository name in lowercase, otherwise it could fail
repo=$(echo "${{ github.repository }}" | tr '[:upper:]' '[:lower:]')
echo "KO_DOCKER_REPO=ghcr.io/${repo}"
echo "KO_DOCKER_REPO=ghcr.io/${repo}" >> $GITHUB_ENV
echo "KO_DOCKER_REPO=ghcr.io/${{ github.repository }}"
echo "KO_DOCKER_REPO=ghcr.io/${{ github.repository }}" >> $GITHUB_ENV
fi

4
go.mod
View File

@ -1,3 +1,3 @@
module github.com/ko-build/setup-ko
module github.com/imjasonh/setup-ko
go 1.22
go 1.16