From fff820b99f36d2a97a30d7465fbe71fba204ca1e Mon Sep 17 00:00:00 2001 From: Jason Hall Date: Tue, 27 Apr 2021 09:41:07 -0400 Subject: [PATCH] Initial commit --- .github/workflows/use-action.yaml | 35 ++++++ LICENSE | 202 ++++++++++++++++++++++++++++++ README.md | 76 +++++++++++ action.yml | 42 +++++++ go.mod | 3 + main.go | 7 ++ 6 files changed, 365 insertions(+) create mode 100644 .github/workflows/use-action.yaml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 action.yml create mode 100644 go.mod create mode 100644 main.go diff --git a/.github/workflows/use-action.yaml b/.github/workflows/use-action.yaml new file mode 100644 index 0000000..1a83499 --- /dev/null +++ b/.github/workflows/use-action.yaml @@ -0,0 +1,35 @@ +name: Use Action + +on: + push: + branches: ['main'] + +jobs: + use-action: + name: Use Action + runs-on: ubuntu-latest + steps: + - uses: actions/setup-go@v2 + with: + go-version: 1.16 + - uses: actions/checkout@v2 + + # Minimal publish + - uses: imjasonh/setup-ko@main + - run: ko publish --bare ./ + + # Install an old release. + - uses: imjasonh/setup-ko@main + with: + version: v0.8.0 + - name: Check installed version + run: ko version | grep 0.8.0 + + # Install from tip + - uses: imjasonh/setup-ko@main + with: + version: tip + - name: Check installed version (tip) + run: | + sudo rm /usr/local/bin/ko # Uninstall previous versions. + ko version diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..63595a9 --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +# GitHub Action to install and setup [`ko`](https://github.com/google/ko) + +[![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 + +```yaml +name: Publish + +on: + push: + branches: ['main'] + +jobs: + publish: + name: Publish + runs-on: ubuntu-latest + steps: + - uses: actions/setup-go@v2 + with: + go-version: 1.15 + - uses: actions/checkout@v2 + + - uses: imjasonh/setup-ko@main + - 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]`. +See [documentation for `ko`](https://github.com/google/ko#configuration) to learn more about configuring `ko`. + +### Select `ko` version to install + +By default, `imjasonh/setup-ko` installs the latest released version of `ko`. + +You can select a version with the `version` parameter: + +```yaml +- uses: imjasonh/setup-ko@main + with: + version: v0.8.0 +``` + +To build and install `ko` from source using `go get`, specify `version: tip`. + +### Pushing to other registries + +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. + +To do this, you need to 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: + +``` +- uses: imjasonh/setup-ko@main +- env: + auth_token: ${{ secrets.auth_token }} + run: | + echo "${auth_token}" | ko login https://my.registry --username my-username --password-stdin + export KO_DOCKER_REPO=my.registry/my-repo + ko publish ./ +``` + +### A note on versioning + +In general it's probably a bad idea to reference the version of the action definition from `main`. +Doing so means I can push changes to the action that will immediately start running as part of your CI workflows. 😱 + +To guard against this, you can reference a specific version of the action definition, for example: + +``` +- uses: imjasonh/setup-ko@v0.0.4 +``` + +Regardless what version of the action you reference, it will _still install the latest version of `ko`_ unless you specify `version:`. + diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..062b495 --- /dev/null +++ b/action.yml @@ -0,0 +1,42 @@ +name: 'Setup ko' +description: 'Install and authorize ko' +branding: + icon: box + color: green +inputs: + version: + description: 'Version of ko to install (tip, latest-release, v0.8.2, etc.)' + required: true + default: 'latest-release' +runs: + using: "composite" + steps: + - shell: bash + run: | + # Install ko: + # - if version is "tip", install from tip of main. + # - if version is "latest-release", look up latest release. + # - otherwise, install the specified version. + case ${{ inputs.version }} in + tip) + echo "Installing ko using go get" + go get github.com/google/ko@main + ;; + latest-release) + tag=$(curl -s https://api.github.com/repos/google/ko/releases | jq -r '.[].tag_name' | head -n 1) + ;; + *) + tag="${{ inputs.version }}" + esac + + if [[ ! -z ${tag} ]]; then + echo "Installing ko @ ${tag}" + curl -fsL https://github.com/google/ko/releases/download/${tag}/ko_${tag:1}_Linux_x86_64.tar.gz | sudo tar xzf - -C /usr/local/bin ko + fi + + # NB: username doesn't seem to matter. + echo "${{ github.token }}" | ko login ghcr.io --username "dummy" --password-stdin + + # Set KO_DOCKER_REPO for future steps. + echo "KO_DOCKER_REPO=ghcr.io/${{ github.repository }}" + echo "KO_DOCKER_REPO=ghcr.io/${{ github.repository }}" >> $GITHUB_ENV diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..739f659 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/imjasonh/setup-ko + +go 1.16 diff --git a/main.go b/main.go new file mode 100644 index 0000000..d8fa929 --- /dev/null +++ b/main.go @@ -0,0 +1,7 @@ +package main + +import "fmt" + +func main() { + fmt.Println("hello") +}