Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add NPM scripts and correct typo #25

Merged
merged 1 commit into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions scripts/github/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# GitHub Repository Scripts

This directory contains scripts that help with individual SDK repo management
This directory contains scripts that help with individual SDK repo management.

## Scripts Description

| Script Name | Description |
| --------------------------- | ----------------------------------------------------------------------------- |
| `npm run create labels` | Creates GitHub labels from a predefined list if they don't already exist. |
| `npm run create-labels` | Creates GitHub labels from a predefined list if they don't already exist. |
| `npm run create-milestones` | Creates GitHub milestones from a predefined list if they don't already exist. |

## Installation and Usage
Expand All @@ -25,4 +25,4 @@ Before running the scripts, ensure that a `.env` file exists and has the followi
| -------------------- | -------------------------------------------- |
| `GH_TOKEN` | Your GitHub personal access token. |
| `GH_OWNER` | The owner username of the GitHub repository. |
| `GH_REPO` | The name of the GitHub repository. |
| `GH_REPO` | The name of the GitHub repository. |
4 changes: 4 additions & 0 deletions scripts/github/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"type": "module",
"scripts": {
"create-labels": "node github-create-labels.js",
"create-milestones": "node github-create-milestones.js"
},
"dependencies": {
"@octokit/core": "5.0.1",
"dotenv": "16.3.1"
Expand Down
Loading