Remove letsencrypt-email flag requirement#137
Conversation
This comment has been minimized.
This comment has been minimized.
|
The build is failing on CI.. and also.. why a draft for a simple flag removal? |
|
Seems like unit tests were not run.. these correspond to the inlets flags and the userdata generation. I guess we want an inlets-pro release before all this is merged. |
Looking into why the tests failed.
Yes we do want in inlets-pro release first. |
29ed1d6 to
c24cd98
Compare
This comment has been minimized.
This comment has been minimized.
Let's Encrypt no longer sends email notification and does not require an email making the --letsencrypt-email flag unnecessary. The inlets http server no longer needs this flag. Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
c24cd98 to
be8983a
Compare
AI Pull Request OverviewSummary
Approval rating (1-10)7 - Code changes are minimal and targeted, but introduces breaking change without clear migration path for existing users. Summary per fileSummary per file
Overall AssessmentThe changes effectively remove the email requirement for Let's Encrypt certificate issuance, aligning with upstream changes. However, this introduces a breaking change for existing users who may have scripts or automation relying on the email flag. The version bump to 0.11.5 assumes this version of inlets-pro supports omitting the email, but this should be verified. Testing coverage appears adequate with unit tests updated, but integration testing against the new inlets-pro version is critical before release. Detailed ReviewDetailed ReviewBreaking Change Impact (High Priority)The removal of Version Bump Assumption (Medium Priority)The code assumes inlets-pro version 0.11.5 supports omitting the Error Handling (Medium Priority)When Test Coverage (Low Priority)Unit tests have been updated appropriately, but there's no test case covering the scenario where a user attempts to provide the email flag. Consider adding a test that verifies the flag is no longer accepted. Security Considerations (Low Priority)Removing the email requirement reduces user friction but also removes a contact method for certificate renewal notifications. While Let's Encrypt no longer requires this, consider documenting the implications for users who may want to receive renewal alerts. Consistency with Upstream (Info)The change aligns with Let's Encrypt's policy change, which is appropriate. However, ensure that inlets-pro's implementation matches this expectation. Code QualityThe changes are minimal and focused, which reduces risk of introducing bugs. Function signatures are correctly updated, and dead code is removed. The user-data script generation properly omits the email parameter. AI agent details. |
Description
Remove the
--letsencrypt-emailflag from the CLI as Let's Encrypt no longer requires an email address for certificate issuance. This simplifies the user experience by removing an unnecessary mandatory parameter when creating tunnel servers with HTTPS domains.How Has This Been Tested?
--letsencrypt-emailflagHow are existing users impacted? What migration steps/scripts do we need?
Breaking Change: Users will need can no longer use the
--letsencrypt-emailflag. The flag is completely removed and will cause an error if specified.Before:
After:
Checklist:
I have:
git commit -sBlockers
--letsencrypt-emailinletsProDefaultVersionneeds to be bumped to the new release version once available