Clear up package name confusion

This commit is contained in:
Josh Gross
2025-01-17 14:37:40 -05:00
parent 2bcb242a0a
commit 7875aed44f
3 changed files with 6 additions and 6 deletions

View File

@@ -429,15 +429,15 @@ jobs:
### Use scripts with jsDoc support
If you want type support for your scripts, you could use the command below to install the
`github-script` type declaration.
`@actions/github-script` type declaration.
```sh
$ npm i -D @types/github-script@github:actions/github-script
$ npm i -D @actions/github-script@github:actions/github-script
```
And then add the `jsDoc` declaration to your script like this:
```js
// @ts-check
/** @param {import('@types/github-script').AsyncFunctionArguments} AsyncFunctionArguments */
/** @param {import('@actions/github-script').AsyncFunctionArguments} AsyncFunctionArguments */
export default async ({ core, context }) => {
core.debug("Running something at the moment");
return context.actor;

4
package-lock.json generated
View File

@@ -1,11 +1,11 @@
{
"name": "github-script",
"name": "@actions/github-script",
"version": "7.0.1",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "github-script",
"name": "@actions/github-script",
"version": "7.0.1",
"license": "MIT",
"dependencies": {

View File

@@ -1,5 +1,5 @@
{
"name": "github-script",
"name": "@actions/github-script",
"description": "A GitHub action for executing a simple script",
"version": "7.0.1",
"author": "GitHub",