Skip to content

Commit

Permalink
feat: add logic
Browse files Browse the repository at this point in the history
  • Loading branch information
SayakMukhopadhyay committed Jun 5, 2024
1 parent 817f477 commit 4f80448
Show file tree
Hide file tree
Showing 16 changed files with 5,318 additions and 361 deletions.
6 changes: 2 additions & 4 deletions .github/linters/.eslintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,8 @@ rules:
'@typescript-eslint/await-thenable': 'error',
'@typescript-eslint/ban-ts-comment': 'error',
'@typescript-eslint/consistent-type-assertions': 'error',
'@typescript-eslint/explicit-member-accessibility':
['error', { 'accessibility': 'no-public' }],
'@typescript-eslint/explicit-function-return-type':
['error', { 'allowExpressions': true }],
'@typescript-eslint/explicit-member-accessibility': ['error', { 'accessibility': 'no-public' }],
'@typescript-eslint/explicit-function-return-type': ['error', { 'allowExpressions': true }],
'@typescript-eslint/func-call-spacing': ['error', 'never'],
'@typescript-eslint/no-array-constructor': 'error',
'@typescript-eslint/no-empty-interface': 'error',
Expand Down
6 changes: 6 additions & 0 deletions .idea/jsLinters/eslint.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

104 changes: 42 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,14 @@

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.
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:
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**
Expand All @@ -27,25 +25,21 @@ follow the below instructions:

> [!IMPORTANT]
>
> Make sure to remove or update the [`CODEOWNERS`](./CODEOWNERS) file! For
> details on how to use this file, see
> 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.
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.
> 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

Expand Down Expand Up @@ -74,23 +68,21 @@ need to perform some initial setup steps before you can develop your action.

## 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
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.
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.
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.
- 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'
Expand Down Expand Up @@ -124,12 +116,10 @@ So, what are you waiting for? Go ahead and start customizing your action!
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.
> 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

Expand All @@ -150,14 +140,12 @@ So, what are you waiting for? Go ahead and start customizing your action!
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.
[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.
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:
Expand All @@ -176,19 +164,16 @@ steps:
run: echo "${{ steps.test-action.outputs.time }}"
```

For example workflow runs, check out the
[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket:
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)
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.
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:
Expand All @@ -209,21 +194,16 @@ steps:

## 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 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.
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 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.
89 changes: 0 additions & 89 deletions __tests__/main.test.ts

This file was deleted.

47 changes: 47 additions & 0 deletions __tests__/pattern-matcher.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import * as core from '@actions/core'
import { IFile } from '../src/github-services'
import { checkChangedFilesAgainstPattern } from '../src/pattern-matcher'
import { afterEach, beforeEach, describe, expect, jest, test } from '@jest/globals'

const coreDebugSpy = jest.fn(() => {})

describe('pattern-matcher', () => {
beforeEach(() => {
jest.spyOn(core, 'debug').mockImplementation(coreDebugSpy)
})

afterEach(() => {
jest.restoreAllMocks()
})

test('if matching pattern is rejected', async () => {
const files: IFile[] = givenFiles()
const pattern = '.*.js'

expect(() => checkChangedFilesAgainstPattern(files, pattern)).toThrow(
new Error(`There is at least one file matching the pattern ${pattern}`)
)
})

test('if non matching pattern is not rejected', async () => {
const files: IFile[] = givenFiles()
const pattern = '.*.ts'

checkChangedFilesAgainstPattern(files, pattern)

expect(coreDebugSpy).toHaveBeenCalledTimes(1)
})

test('if empty commit is not rejected', async () => {
const files: IFile[] = []
const pattern = '.*'

checkChangedFilesAgainstPattern(files, pattern)

expect(coreDebugSpy).toHaveBeenCalledTimes(1)
})
})

function givenFiles(): IFile[] {
return [{ filename: 'src/file1.js' }, { filename: 'README.md' }]
}
25 changes: 0 additions & 25 deletions __tests__/wait.test.ts

This file was deleted.

2 changes: 1 addition & 1 deletion badges/coverage.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 4f80448

Please sign in to comment.