Skip to content

Commit

Permalink
Initial impl (#3)
Browse files Browse the repository at this point in the history 
* initial impl

* some adjustments

* updating

* also log the outputs

* Ignore raw inputs file

* not sure why all didnt also regen these...

* make sure to mock impl so setfailed doesnt exit 1
  • Loading branch information
@benlei
benlei authored Oct 25, 2024
1 parent 6f52358 commit 418f2ee
Show file tree
Hide file tree
Showing 26 changed files with 7,405 additions and 577 deletions.
8 changes: 6 additions & 2 deletions .devcontainer/devcontainer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,19 @@
"me-dutour-mathieu.vscode-github-actions",
"redhat.vscode-yaml",
"rvest.vs-code-prettier-eslint",
"yzhang.markdown-all-in-one"
"yzhang.markdown-all-in-one",
"firsttris.vscode-jest-runner"
],
"settings": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.tabSize": 2,
"editor.formatOnSave": true,
"markdown.extension.list.indentationSize": "adaptive",
"markdown.extension.italic.indicator": "_",
"markdown.extension.orderedList.marker": "one"
"markdown.extension.orderedList.marker": "one",
"github.copilot.enable": {
"markdown": true
}
}
}
},
Expand Down
32 changes: 32 additions & 0 deletions .github/workflows/ci-merged.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Continuous Integration

on:
push:
branches:
- main

permissions:
contents: read
pull-requests: read

jobs:
test-action:
name: GitHub Actions Test
runs-on: ubuntu-latest

steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4

- name: Test Local Action
id: test-action
uses: ./

- name: Log the outputs
run: |
echo ${{ toJSON(toJSON(steps.test-action.outputs)) }}
- name: PR should have been found
if: ${{ steps.test-action.outputs.number == '' }}
run: exit 1
19 changes: 0 additions & 19 deletions .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,22 +43,3 @@ jobs:
- name: Test
id: npm-ci-test
run: npm run ci-test

test-action:
name: GitHub Actions Test
runs-on: ubuntu-latest

steps:
- name: Checkout
id: checkout
uses: actions/checkout@v4

- name: Test Local Action
id: test-action
uses: ./
with:
milliseconds: 2000

- name: Print Output
id: output
run: echo "${{ steps.test-action.outputs.time }}"
2 changes: 1 addition & 1 deletion CODEOWNERS
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Repository CODEOWNERS

* @actions/actions-oss-maintainers
* @benlei
289 changes: 41 additions & 248 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,263 +1,56 @@
# Create a GitHub Action Using TypeScript
# benlei/get-merged-pull-request

[![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![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)
[![GitHub Super-Linter](https://github.com/benlei/get-merged-pull-request/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
![CI](https://github.com/benlei/get-merged-pull-request/actions/workflows/ci.yml/badge.svg)
[![Check dist/](https://github.com/benlei/get-merged-pull-request/actions/workflows/check-dist.yml/badge.svg)](https://github.com/benlei/get-merged-pull-request/actions/workflows/check-dist.yml)
[![CodeQL](https://github.com/benlei/get-merged-pull-request/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/benlei/get-merged-pull-request/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 action can be used to try to match the current commit of the running
workflow to a closed (merged) pull request. This can be useful for workflows
where you need information about the pull request that was just merged but can't
use the `pull_request` event due to the limitations around the event.

This template includes compilation support, tests, a validation workflow,
publishing, and versioning guidance.
## Inputs

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).
<!-- markdownlint-disable MD013 -->

## Create Your Own Action
| Name | Required | Default | Description |
| ------------ | -------- | --------------------- | ------------------------------------------------------------------ |
| `token` | no | `${{ github.token }}` | GitHub token to use for API requests. |
| `page-limit` | no | `1` | The maximum number of pages to search for a matching pull request. |

To create your own action, you can use this repository as a template! Just
follow the below instructions:
<!-- markdownlint-enable MD013 -->

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
## Outputs

> [!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).
<!-- markdownlint-disable MD013 -->

## Initial Setup
| Name | Description |
| ---------------- | ----------------------------------------------------------------------- |
| `number` | The number of the pull request that was merged. |
| `title` | The title of the pull request that was merged. |
| `body` | The body of the pull request that was merged. |
| `labels` | The labels of the pull request that was merged, separated by commas. |
| `labels-json` | The labels of the pull request that was merged, in JSON format. |
| `user` | The user that opened the pull request that was merged. |
| `assignees` | The assignees of the pull request that was merged, separated by commas. |
| `assignees-json` | The assignees of the pull request that was merged, in JSON format. |
| `milestone` | The milestone of the pull request that was merged. |
| `merged_by` | The user that merged the pull request that was merged. |

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.
<!-- markdownlint-enable MD013 -->

> [!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. (Optional) Test your action locally

The [`@github/local-action`](https://github.com/github/local-action) utility
can be used to test your action locally. It is a simple command-line tool
that "stubs" (or simulates) the GitHub Actions Toolkit. This way, you can run
your TypeScript action locally without having to commit and push your changes
to a repository.

The `local-action` utility can be run in the following ways:

- Visual Studio Code Debugger

Make sure to review and, if needed, update
[`.vscode/launch.json`](./.vscode/launch.json)

- Terminal/Command Prompt

```bash
# npx local action <action-yaml-path> <entrypoint> <dotenv-file>
npx local-action . src/main.ts .env
```

You can provide a `.env` file to the `local-action` CLI to set environment
variables used by the GitHub Actions Toolkit. For example, setting inputs and
event payload data used by your action. For more information, see the example
file, [`.env.example`](./.env.example), and the
[GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).

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.
## Example usage

```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 }}"
- name: Get merged pull request
id: merged
uses: benlei/get-merged-pull-request@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}

- name: Send a message if the merged pull request contains a 'fix' label
if: ${{ contains(fromJSON(steps.merged.outputs.labels-json), 'fix') }}
run: echo "The merged pull request contains a 'fix' label."
```

## Publishing a New Release

This project includes a helper script, [`script/release`](./script/release)
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. This script simplifies this process by performing the
following steps:

1. **Retrieving the latest release tag:** The script starts by fetching the most
recent SemVer release tag of the current branch, 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 tag retrieved in
the previous step, and validates the format of the inputted tag (vX.X.X). The
user is also reminded to update the version field in package.json.
1. **Tagging the new release:** The script then tags a new release and syncs the
separate major tag (e.g. v1, v2) with the new release tag (e.g. v1.0.0,
v2.1.2). When the user is creating a new major release, the script
auto-detects this and creates a `releases/v#` branch for the previous major
version.
1. **Pushing changes to remote:** Finally, the script pushes the necessary
commits, tags and branches to the remote repository. From here, you will need
to create a new release in GitHub so users can easily reference the new tags
in their workflows.
Loading

0 comments on commit 418f2ee

Please sign in to comment.