Skip to content

#8 – initial TS support + release workflow#9

Merged
acamposuribe merged 5 commits intoacamposuribe:mainfrom
joeyfigaro:typescript-support
Dec 13, 2023
Merged

#8 – initial TS support + release workflow#9
acamposuribe merged 5 commits intoacamposuribe:mainfrom
joeyfigaro:typescript-support

Conversation

@joeyfigaro
Copy link
Copy Markdown
Contributor

@joeyfigaro joeyfigaro commented Nov 22, 2023

For #8

  • Adds required dependencies, configuration, and lifecycle scripts for generating typescript declarations from source js
  • Adds release workflow for generating typescript declarations as part of the push new release to npm process

.github/workflows/release.yml
This is an automated workflow for your repository. Every time a new commit is pushed to main it will automatically build typescript declarations. We may need to also commit the generated typings so they're stored alongside your source files.

known steps remaining for NPM publishing

  • create and store NPM token so your automated workflow can successfully publish releases
  • add .npmignore to exclude files/assets from your published releases (you'll probably want to add your third-party dependencies so they aren't included when users install p5.brush)
  • uncommenting the publish job in .github/workflows/release.yml (or creating your own)
  • testing that npm install works as expected for users trying to use p5.brush

@vercel
Copy link
Copy Markdown

vercel Bot commented Nov 22, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
brushbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 22, 2023 2:35am

Copy link
Copy Markdown
Owner

@acamposuribe acamposuribe left a comment

Choose a reason for hiding this comment

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

Cool

Copy link
Copy Markdown
Owner

@acamposuribe acamposuribe left a comment

Choose a reason for hiding this comment

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

Cool

@acamposuribe acamposuribe merged commit 2cb78de into acamposuribe:main Dec 13, 2023
@joeyfigaro joeyfigaro deleted the typescript-support branch December 28, 2023 22:27
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