Merge pull request #514 from actions/joshmgross/update-package-name

Clear up package name confusion
This commit is contained in:
Josh Gross
2025-01-17 15:00:06 -05:00
committed by GitHub
4 changed files with 7 additions and 7 deletions

View File

@@ -39,7 +39,7 @@ jobs:
result-encoding: string result-encoding: string
- run: | - run: |
echo "- Validating relative require output" echo "- Validating relative require output"
if [[ "${{steps.relative-require.outputs.result}}" != "github-script" ]]; then if [[ "${{steps.relative-require.outputs.result}}" != "@actions/github-script" ]]; then
echo $'::error::\u274C' "Expected '$expected', got ${{steps.relative-require.outputs.result}}" echo $'::error::\u274C' "Expected '$expected', got ${{steps.relative-require.outputs.result}}"
exit 1 exit 1
fi fi

View File

@@ -429,15 +429,15 @@ jobs:
### Use scripts with jsDoc support ### Use scripts with jsDoc support
If you want type support for your scripts, you could use the command below to install the 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 ```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: And then add the `jsDoc` declaration to your script like this:
```js ```js
// @ts-check // @ts-check
/** @param {import('@types/github-script').AsyncFunctionArguments} AsyncFunctionArguments */ /** @param {import('@actions/github-script').AsyncFunctionArguments} AsyncFunctionArguments */
export default async ({ core, context }) => { export default async ({ core, context }) => {
core.debug("Running something at the moment"); core.debug("Running something at the moment");
return context.actor; 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", "version": "7.0.1",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "github-script", "name": "@actions/github-script",
"version": "7.0.1", "version": "7.0.1",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {

View File

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