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!(core): add required Forge version for templates #2415

Merged
merged 10 commits into from
Aug 1, 2021

Conversation

malept
Copy link
Member

@malept malept commented Jul 30, 2021

  • 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:

BREAKING CHANGE: Electron Forge templates compatible with v6 must specify the required Forge version (i.e., a semver range) supported by the template, using the requiredForgeVersion attribute on the class implementing ForgeTemplate.

This is largely to prevent the built-in templates from v5 from being used with v6.

Documented at the Electron Forge website.

malept added 3 commits July 29, 2021 07:54
BREAKING CHANGE: Electron Forge templates compatible with v6 must
specify the minimum Forge version supported by the template, using the
`minimumForgeVersion` attribute on the class implementing `ForgeTemplate`.

This is largely to prevent the built-in templates from v5 from being
used with v6.

Note that actually checking whether the version matches has not been
implemented yet.
@codecov
Copy link

codecov bot commented Jul 30, 2021

Codecov Report

Merging #2415 (2fa573a) into master (c0807e8) will increase coverage by 0.08%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2415      +/-   ##
==========================================
+ Coverage   75.03%   75.11%   +0.08%     
==========================================
  Files          91       91              
  Lines        2339     2347       +8     
  Branches      437      439       +2     
==========================================
+ Hits         1755     1763       +8     
  Misses        476      476              
  Partials      108      108              
Impacted Files Coverage Δ
packages/api/core/src/api/init.ts 97.56% <100.00%> (+0.50%) ⬆️
packages/template/base/src/BaseTemplate.ts 97.82% <100.00%> (+0.04%) ⬆️

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 c0807e8...2fa573a. Read the comment docs.

@malept malept marked this pull request as ready for review July 31, 2021 00:31
@malept malept merged commit c094d16 into master Aug 1, 2021
@malept malept deleted the feat/template-min-forge-version branch August 1, 2021 14:44
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