Skip to content

Commit

Permalink
Update references to core lib
Browse files Browse the repository at this point in the history
  • Loading branch information
lerebear committed Oct 9, 2023
1 parent a6754a7 commit 03cf563
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# SizeUp Action

This repository contains a GitHub Action that wraps the [`sizeup` library](https://github.com/lerebear/sizeup) in order to provide a way to estimate the reviewability of a pull request as it goes through its lifecycle on GitHub.
This repository contains a GitHub Action that wraps the [`sizeup-core` library](https://github.com/lerebear/sizeup-core) in order to provide a way to estimate the reviewability of a pull request as it goes through its lifecycle on GitHub.

## Usage

See [`action.yml`](./action.yml)

```yaml
- name: Estimate pull request reviewability
uses: lerebear/sizeup-action@main
uses: lerebear/sizeup-action@v0.1.2
id: sizeup-action
with:
# A GitHub API token capable of reading pull requests on the repository
Expand All @@ -31,7 +31,7 @@ See [`action.yml`](./action.yml)
## Configuration
This Action can be configured by specifying the `configuration-file` input. The value of that input should be the path to a YAML file that contains configuration for this Action and the underlying `sizeup` library.
This Action can be configured by specifying the `configuration-file` input. The value of that input should be the path to a YAML file that contains configuration for this Action and the underlying `sizeup-core` library.

An example configuration file looks like this:

Expand All @@ -52,7 +52,7 @@ optIns:
- glortho
# Configuration for how to evaluate pull requests.
# This is of the same format that `sizeup` accepts directly.
# This is of the same format that `sizeup-core` accepts directly.
sizeup:
categories:
- name: extra small
Expand Down Expand Up @@ -93,12 +93,12 @@ The default configuration that is used when no configuration file is provided ca

The full specification for the configuration file is provide by the JSON schema at [`src/config/schema.json`](./src/config/schema/json).

For details on what configuration can be provided under the `sizeup` key, please see the [`sizeup` library's configuration guide](https://github.com/lerebear/sizeup#configuration).
For details on what configuration can be provided under the `sizeup` key, please see the [`sizeup-core` library's configuration guide](https://github.com/lerebear/sizeup-core#configuration).

## Development

This section contains notes for how to develop this library.

### Regenerating the Typescript interface for the configuration schema

Follow the same [procedure](https://github.com/lerebear/sizeup#regenerating-the-typescript-interface-for-the-configuration-schema) outlined for this process in the sizeup repository.
Follow the same [procedure](https://github.com/lerebear/sizeup-core#regenerating-the-typescript-interface-for-the-configuration-schema) outlined for this process in the `sizeup-core` repository.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sizeup-action",
"description": "GitHub Actions wrapper for the sizeup library",
"description": "GitHub Actions wrapper for the sizeup-core library",
"version": "0.1.2",
"author": "Ọlálérè Williams",
"private": true,
Expand Down

0 comments on commit 03cf563

Please sign in to comment.