Skip to content

Commit

Permalink
refactor: polish
Browse files Browse the repository at this point in the history
  • Loading branch information
Yohe-Am committed Dec 15, 2023
1 parent f6b33d1 commit 41cd02d
Show file tree
Hide file tree
Showing 10 changed files with 42 additions and 286 deletions.
4 changes: 1 addition & 3 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
lib/
dist/
node_modules/
coverage/
index.js
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
48 changes: 0 additions & 48 deletions .github/workflows/codeql-analysis.yml

This file was deleted.

5 changes: 3 additions & 2 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dist/
node_modules/
coverage/
index.js
ghjk.ts
LICENSE
4 changes: 0 additions & 4 deletions CODEOWNERS

This file was deleted.

239 changes: 22 additions & 217 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
10 changes: 7 additions & 3 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions main.cjs
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
const { main } = require("./index.js");
const { main } = require('./index.js')

void main();
void main()
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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 ."
},
Expand Down
4 changes: 2 additions & 2 deletions post.cjs
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
const { post } = require("./index.js");
const { post } = require('./index.js')

void post();
void post()

0 comments on commit 41cd02d

Please sign in to comment.