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

feat: add TypeScript definition #1131

Merged
merged 2 commits into from
Mar 2, 2020
Merged

feat: add TypeScript definition #1131

merged 2 commits into from
Mar 2, 2020

Conversation

malept
Copy link
Member

@malept malept commented Feb 29, 2020

  • I have read the contribution documentation for this project.
  • I agree to follow the code of conduct that this project follows, as appropriate.
  • The changes are appropriately documented (if applicable).
  • The changes have sufficient test coverage (if applicable).
  • The testsuite passes successfully on my local machine (if applicable).

Summarize your changes:

Based on @types/electron-packager, it's updated for 14.2.1. It replaces docs/api.md as the canonical API documentation (docs/api.md remains with a link-based redirect for links to the Markdown file).

I've tested this definition with Electron Forge locally.

Additionally, this adds a GitHub Action to build the docs for master & tags, and publishes them to GitHub Pages.

@codecov
Copy link

codecov bot commented Feb 29, 2020

Codecov Report

Merging #1131 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master     #1131   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        14           
  Lines          712       712           
=========================================
  Hits           712       712           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 61f6c0c...ef72f43. Read the comment docs.

@malept malept force-pushed the typescript-definition branch from 67d1015 to 8d28e1c Compare February 29, 2020 07:41
Based on `@types/electron-packager`, it's updated for 14.2.1.
It replaces `docs/api.md` as the canonical API documentation.
@malept malept force-pushed the typescript-definition branch 2 times, most recently from e04e2ec to 1b2dd58 Compare February 29, 2020 08:54
@malept malept force-pushed the typescript-definition branch from 1b2dd58 to ef72f43 Compare February 29, 2020 09:09
malept added a commit to malept/electron that referenced this pull request Feb 29, 2020
* Grammar fixes
* Add links for Electron Packager & Electron Forge
* Update Packager API links, given electron/packager#1131
@malept malept merged commit a2a3ae5 into master Mar 2, 2020
@malept malept deleted the typescript-definition branch March 2, 2020 20:26
malept added a commit to malept/electron that referenced this pull request Mar 2, 2020
* Grammar fixes
* Add links for Electron Packager & Electron Forge
* Update Packager API links, given electron/packager#1131
MarshallOfSound added a commit to electron/electron that referenced this pull request Mar 5, 2020
* docs: clean up systemPreferences.effectiveAppearance text

* Grammar fixes
* Add links for Electron Packager & Electron Forge
* Update Packager API links, given electron/packager#1131

* docs: clean up Dark Mode guide

* Grammar fixes
* Add links for Electron Packager & Electron Forge

* docs: adjust based on Electron 8 using 10.14 SDK
trop bot pushed a commit to electron/electron that referenced this pull request Mar 5, 2020
* Grammar fixes
* Add links for Electron Packager & Electron Forge
* Update Packager API links, given electron/packager#1131
zcbenz pushed a commit to electron/electron that referenced this pull request Mar 6, 2020
* docs: clean up systemPreferences.effectiveAppearance text

* Grammar fixes
* Add links for Electron Packager & Electron Forge
* Update Packager API links, given electron/packager#1131

* docs: clean up Dark Mode guide

* Grammar fixes
* Add links for Electron Packager & Electron Forge

* docs: adjust based on Electron 8 using 10.14 SDK

Co-authored-by: Mark Lee <[email protected]>
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.

1 participant