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

Update Readme #997

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Readme #997

wants to merge 2 commits into from

Conversation

antonu17
Copy link

Description

In addition to: #969

Reflect switch from @vercel/ncc to rollup in README.md

@antonu17 antonu17 requested a review from a team as a code owner January 17, 2025 14:57
@ncalteen ncalteen self-assigned this Jan 17, 2025
Copy link
Collaborator

@ncalteen ncalteen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching that!

README.md Outdated
Comment on lines 127 to 130
> This step is important! It will run [`rollup`](https://rollupjs.org/)
> 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.
> used in a workflow.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatter is picky about the updated lines. Can you update with the following?

   > This step is important! It will run [`rollup`](https://rollupjs.org/) 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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤓
I should've run the linter locally. Thanks for the fix suggestion!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants