From 41cd02de08ddac11436a3627a356899e996013bf Mon Sep 17 00:00:00 2001 From: Yohe-Am <56622350+Yohe-Am@users.noreply.github.com> Date: Fri, 15 Dec 2023 11:21:14 +0000 Subject: [PATCH] refactor: polish --- .eslintignore | 4 +- .github/workflows/ci.yml | 6 +- .github/workflows/codeql-analysis.yml | 48 ------ .prettierignore | 5 +- CODEOWNERS | 4 - README.md | 239 +++----------------------- action.yml | 10 +- main.cjs | 4 +- package.json | 4 +- post.cjs | 4 +- 10 files changed, 42 insertions(+), 286 deletions(-) delete mode 100644 .github/workflows/codeql-analysis.yml delete mode 100644 CODEOWNERS diff --git a/.eslintignore b/.eslintignore index 9ff5c1c..f614508 100644 --- a/.eslintignore +++ b/.eslintignore @@ -1,4 +1,2 @@ -lib/ -dist/ node_modules/ -coverage/ +index.js diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 24c0704..15bdad8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -25,6 +25,6 @@ jobs: env: GHJK_VERSION: 6040bb3 - - name: Print Output - id: output - run: echo "${{ steps.test-action.outputs.time }}" + - name: Check avail of pnpm + shell: bash + run: pnpm --version diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml deleted file mode 100644 index bcaf277..0000000 --- a/.github/workflows/codeql-analysis.yml +++ /dev/null @@ -1,48 +0,0 @@ -name: CodeQL - -on: - push: - branches: - - main - pull_request: - branches: - - main - schedule: - - cron: '31 7 * * 3' - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - - permissions: - actions: read - checks: write - contents: read - security-events: write - - strategy: - fail-fast: false - matrix: - language: - - TypeScript - - steps: - - name: Checkout - id: checkout - uses: actions/checkout@v4 - - - name: Initialize CodeQL - id: initialize - uses: github/codeql-action/init@v2 - with: - languages: ${{ matrix.language }} - source-root: src - - - name: Autobuild - id: autobuild - uses: github/codeql-action/autobuild@v2 - - - name: Perform CodeQL Analysis - id: analyze - uses: github/codeql-action/analyze@v2 diff --git a/.prettierignore b/.prettierignore index 2d0c064..fbddacd 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,3 +1,4 @@ -dist/ node_modules/ -coverage/ +index.js +ghjk.ts +LICENSE diff --git a/CODEOWNERS b/CODEOWNERS deleted file mode 100644 index a9802d7..0000000 --- a/CODEOWNERS +++ /dev/null @@ -1,4 +0,0 @@ -# Repository CODEOWNERS - -* @actions/actions-runtime -* @ncalteen diff --git a/README.md b/README.md index f198d8a..6424cde 100644 --- a/README.md +++ b/README.md @@ -4,227 +4,32 @@ ![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg) [![Check dist/](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/check-dist.yml) [![CodeQL](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/actions/typescript-action/actions/workflows/codeql-analysis.yml) -[![Coverage](./badges/coverage.svg)](./badges/coverage.svg) - -Use this template to bootstrap the creation of a TypeScript action. :rocket: - -This template includes compilation support, tests, a validation workflow, -publishing, and versioning guidance. - -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). - -## 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 - ``` - - > [!WARNING] - > - > 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. - -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. - ```yaml steps: - - name: Checkout - id: checkout - uses: actions/checkout@v4 - - - 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 }}" + - uses: metatypedev/setup-ghjk@v1 ``` -## Publishing a new release - -This project includes a helper script designed to streamline the process of -tagging and pushing new releases for GitHub Actions. - -GitHub Actions allows users to select a specific version of the action to use, -based on release tags. Our script simplifies this process by performing the -following steps: - -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. +## Inputs + +| Input | Desc | Default | +| --------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| `version` | `Ghjk version/ref to use`. | `GHJK_VERSION` or latest Github release from ghjk repo | +| `skip-deno-install` | Avoid installing separate deno and use what's found in environment. | `false` | +| `installer-url` | Installer script to use. | `https://raw.github.com/metatypedev/ghjk/${version}/install.ts` | +| `sync` | Weather or not to run `ghjk ports sync`. | `true` | +| `cache-disable` | Disable caching `$GHJK_DIR/envs`. | `false` | +| `cache-save-if` | Weather or not to enable cache saving. Doesn't affect cache restore step. | `true` | +| `cache-key-prefix` | Override to add more target entropy to the cache key. | `v0-ghjk` | +| `cache-key-env-vars:` | Comma separated list of prefixes to match env var names to. Matches will be hashed into cache key. | "", GHJK and DENO are included by always. | + +| Env vars | Desc | Default | +| -------------------------- | -------------------------------------------------------------------------------------------- | ------------------------- | +| `GHJK_DIR` | Root directory for ghjk installation and envs. | `$HOME/.local/share/ghjk` | +| `GHJK_INSTALL_EXE_DIR` | Location to install the `ghjk` exec. | `$HOME/.local/bin` | +| `GHJK_INSTALL_DENO_EXEC` | Alternative deno exec to use. This will not affect weather or not deno is installed as well. | `"deno"` | +| `GHJK_INSTALL_HOOK_SHELLS` | Comma separated list of shells to hook. | `bash` | +| `GHJK_INSTALL_HOOK_MARKER` | Marker to use when installing shell hooks. Hardly relevant in actions. | `ghjk-hook-marker` | +| `GHJK_INSTALL_NO_LOCKFILE` | Hardcode `--no-lock` into the ghjk exec. | `false` | diff --git a/action.yml b/action.yml index b2dfea5..5ebc4d1 100644 --- a/action.yml +++ b/action.yml @@ -5,7 +5,8 @@ inputs: description: 'Github version/branch to install from' required: false skip-deno-install: - description: 'Use to avoid share another deno exec already installed in workflow' + description: + 'Use to avoid share another deno exec already installed in workflow' required: false default: false installer-url: @@ -20,14 +21,17 @@ inputs: required: true default: false cache-save-if: - description: "Toggle cache saving. To disable cache restore as well, use cache-disable" + description: + 'Toggle cache saving. To disable cache restore as well, use cache-disable' required: true default: true cache-key-prefix: description: 'Prefix to use for the cache key. v0-ghjk by default' required: false cache-key-env-vars: - description: "Additional environment variables to include in the cache key, separated by comma." + description: + 'Additional environment variables to include in the cache key, separated + by comma.' required: false runs: diff --git a/main.cjs b/main.cjs index 225c568..7237450 100644 --- a/main.cjs +++ b/main.cjs @@ -1,3 +1,3 @@ -const { main } = require("./index.js"); +const { main } = require('./index.js') -void main(); +void main() diff --git a/package.json b/package.json index 7daa6ec..2ff933b 100644 --- a/package.json +++ b/package.json @@ -16,8 +16,8 @@ }, "scripts": { "lint": "pnpm dlx eslint . -c ./.github/linters/.eslintrc.yml", - "format:write": "prettier --write index.ts", - "format:check": "prettier --check index.ts", + "format:write": "prettier --write *", + "format:check": "prettier --check *", "build": "ncc build index.ts -o .", "build:watch": "ncc build index.ts -w -o ." }, diff --git a/post.cjs b/post.cjs index 89b3be2..ad991d7 100644 --- a/post.cjs +++ b/post.cjs @@ -1,3 +1,3 @@ -const { post } = require("./index.js"); +const { post } = require('./index.js') -void post(); +void post()