From 1d7558b80081e221803c98f31233d503f4608b31 Mon Sep 17 00:00:00 2001 From: Daniel Sarfati Date: Thu, 18 Apr 2024 10:05:34 -0600 Subject: [PATCH] Updated Readme --- README.md | 250 +++++++++-------------------------------------------- action.yml | 3 +- 2 files changed, 41 insertions(+), 212 deletions(-) diff --git a/README.md b/README.md index 3e1c006..164fe65 100644 --- a/README.md +++ b/README.md @@ -1,229 +1,57 @@ -# Create a GitHub Action Using TypeScript +# Automatically Deploy Containers to Salad's SCE + -Use this template to bootstrap the creation of a TypeScript action. :rocket: +# Usage Example -This template includes compilation support, tests, a validation workflow, -publishing, and versioning guidance. +Place the following in step in your github actions -If you are new, there's also a simpler introduction in the -[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action). +```yml + - name: Deploy Update to SCE + uses: SaladTechnologies/sce-deploy@v1 + with: + salad_organization: + salad_project: + salad_container_group: + salad_api_key: ${{secrets.SALAD_API_KEY}} + image_name: -## Create Your Own Action - -To create your own action, you can use this repository as a template! Just -follow the below instructions: - -1. Click the **Use this template** button at the top of the repository -1. Select **Create a new repository** -1. Select an owner and name for your new repository -1. Click **Create repository** -1. Clone your new repository - -> [!IMPORTANT] -> -> Make sure to remove or update the [`CODEOWNERS`](./CODEOWNERS) file! For -> details on how to use this file, see -> [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners). - -## Initial Setup - -After you've cloned the repository to your local machine or codespace, you'll -need to perform some initial setup steps before you can develop your action. - -> [!NOTE] -> -> You'll need to have a reasonably modern version of -> [Node.js](https://nodejs.org) handy (20.x or later should work!). If you are -> using a version manager like [`nodenv`](https://github.com/nodenv/nodenv) or -> [`nvm`](https://github.com/nvm-sh/nvm), this template has a `.node-version` -> file at the root of the repository that will be used to automatically switch -> to the correct version when you `cd` into the repository. Additionally, this -> `.node-version` file is used by GitHub Actions in any `actions/setup-node` -> actions. - -1. :hammer_and_wrench: Install the dependencies - - ```bash - npm install - ``` - -1. :building_construction: Package the TypeScript for distribution - - ```bash - npm run bundle - ``` - -1. :white_check_mark: Run the tests - - ```bash - $ npm test - - PASS ./index.test.js - ✓ throws invalid number (3ms) - ✓ wait 500 ms (504ms) - ✓ test runs (95ms) - - ... - ``` - -## Update the Action Metadata - -The [`action.yml`](action.yml) file defines metadata about your action, such as -input(s) and output(s). For details about this file, see -[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions). - -When you copy this repository, update `action.yml` with the name, description, -inputs, and outputs for your action. - -## Update the Action Code - -The [`src/`](./src/) directory is the heart of your action! This contains the -source code that will be run when your action is invoked. You can replace the -contents of this directory with your own code. - -There are a few things to keep in mind when writing your action code: - -- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously. - In `main.ts`, you will see that the action is run in an `async` function. - - ```javascript - import * as core from '@actions/core' - //... - - async function run() { - try { - //... - } catch (error) { - core.setFailed(error.message) - } - } - ``` - - For more information about the GitHub Actions toolkit, see the - [documentation](https://github.com/actions/toolkit/blob/master/README.md). - -So, what are you waiting for? Go ahead and start customizing your action! - -1. Create a new branch - - ```bash - git checkout -b releases/v1 - ``` - -1. Replace the contents of `src/` with your action code -1. Add tests to `__tests__/` for your source code -1. Format, test, and build the action - - ```bash - npm run all - ``` - - > This step is important! It will run [`ncc`](https://github.com/vercel/ncc) - > to build the final JavaScript action code with all dependencies included. - > If you do not run this step, your action will not work correctly when it is - > used in a workflow. This step also includes the `--license` option for - > `ncc`, which will create a license file for all of the production node - > modules used in your project. - -1. Commit your changes - - ```bash - git add . - git commit -m "My first action is ready!" - ``` - -1. Push them to your repository - - ```bash - git push -u origin releases/v1 - ``` - -1. Create a pull request and get feedback on your action -1. Merge the pull request into the `main` branch - -Your action is now published! :rocket: - -For information about versioning your action, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) -in the GitHub Actions toolkit. - -## Validate the Action - -You can now validate the action by referencing it in a workflow file. For -example, [`ci.yml`](./.github/workflows/ci.yml) demonstrates how to reference an -action in the same repository. - -```yaml -steps: - - name: Checkout - id: checkout - uses: actions/checkout@v4 - - - name: Test Local Action - id: test-action - uses: ./ - with: - milliseconds: 1000 - - - name: Print Output - id: output - run: echo "${{ steps.test-action.outputs.time }}" ``` -For example workflow runs, check out the -[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket: - -## Usage - -After testing, you can create version tag(s) that developers can use to -reference different stable versions of your action. For more information, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) -in the GitHub Actions toolkit. +# Requirements -To include the action in a workflow in another repository, you can use the -`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit -hash. +- You must already have a Salad account with an existing container group. This + github action will simply update the image for the container group. All other + updates can be made using either the portal or the public API. +- You must get your Salad API key [here](https://portal.salad.com/api-key). It + is highly recommended to store this in Github as a secret (see example above). -```yaml -steps: - - name: Checkout - id: checkout - uses: actions/checkout@v4 +# Setup Steps - - name: Test Local Action - id: test-action - uses: actions/typescript-action@v1 # Commit with the `v1` tag - with: - milliseconds: 1000 - - - name: Print Output - id: output - run: echo "${{ steps.test-action.outputs.time }}" -``` +1. Create a Salad account at https://portal.salad.com +2. Get the API key for your Salad account + [here](https://portal.salad.com/api-key) +3. Create a container group to configure hardware requirements, env vars... +4. Update the github action to include the salad organization, project & + container group -## Publishing a New Release +### Settings -This project includes a helper script, [`script/release`](./script/release) -designed to streamline the process of tagging and pushing new releases for -GitHub Actions. +Keys can be added directly to your .yml config file or referenced from your +project `Secrets` storage. -GitHub Actions allows users to select a specific version of the action to use, -based on release tags. This script simplifies this process by performing the -following steps: +To add a `secret` go to the `Settings` tab in your project then select +`Secrets`. We strongly recommend you store your `password` as a secret. -1. **Retrieving the latest release tag:** The script starts by fetching the most - recent release tag by looking at the local data available in your repository. -1. **Prompting for a new release tag:** The user is then prompted to enter a new - release tag. To assist with this, the script displays the latest release tag - and provides a regular expression to validate the format of the new tag. -1. **Tagging the new release:** Once a valid new tag is entered, the script tags - the new release. -1. **Pushing the new tag to the remote:** Finally, the script pushes the new tag - to the remote repository. From here, you will need to create a new release in - GitHub and users can easily reference the new tag in their workflows. +| Key Name | Required | Example | Description | +| ----------------------- | -------- | -------------------------- | ------------------------------------------------------------------ | +| `salad_organization` | Yes | `salad` | The Salad organization name. Can be found in the portal url | +| `salad_project` | Yes | `production` | The Salad project name. Can be found in the portal url | +| `salad_container_group` | Yes | `my-container-group` | The Salad container group name. Can be found in the portal url bar | +| `salad_api_key` | Yes | `********` | The Salad API key | +| `image_name` | Yes | `ghcr.io/my-container:0.1` | The full image name, including registry, image name and tag | diff --git a/action.yml b/action.yml index 832de54..671442f 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,6 @@ name: 'Salad Container Engine Action' -description: 'Automatically deploy new GHCR containers to your Salad Account.' +description: + 'Automatically deploy updated container images to your Salad Account.' author: 'SaladTechnologies' # Add your action's branding here. This will appear on the GitHub Marketplace.