Skip to content

fix: revert igniter dep to optional: true for v0.4.1#63

Merged
vincentvanbush merged 2 commits into
masterfrom
patch/revert-igniter-to-optional
May 22, 2026
Merged

fix: revert igniter dep to optional: true for v0.4.1#63
vincentvanbush merged 2 commits into
masterfrom
patch/revert-igniter-to-optional

Conversation

@vincentvanbush

Copy link
Copy Markdown
Collaborator

Pull Request

In permit v0.4.0 (as well as permit_ecto v0.3.0, permit_phoenix v0.5.0, permit_absinthe v0.3.0) we messed up a little bit with the way they depend on igniter: instead of optional: true we made them only: [:dev, :test] aiming to not require the developer to add igniter to their mixfile.

This was wrong because with only: [:dev, :test], igniter was excluded entirely from the compiled app code and the Mix.Tasks.Permit.Install module was never defined. With optional: true, igniter compiles into the project when explicitly added (or when mix igniter.install permit pulls it in), so the task becomes available.

Let's stick to the standard in most Igniter-powered libs and revert to optional: true.

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Code refactoring
  • Test improvements
  • CI/CD improvements

Related Issues

Fixes #
Closes #
Related to #

Changes Made

Testing

Test Environment

  • Elixir version:
  • OTP version:
  • Database:

Test Cases

  • All existing tests pass
  • New tests added for new functionality at appropriate levels
  • Manual testing performed

Test Commands Run

# List the commands you ran to test
mix test
MIX_ENV=test mix credo
MIX_ENV=test mix dialyzer

Documentation

  • Updated README.md (if applicable)
  • Updated documentation comments (with examples for new features)
  • Updated CHANGELOG.md (if applicable)

Code Quality

  • Code follows the existing style conventions
  • Self-review of the code has been performed
  • Code has been commented, particularly in hard-to-understand areas
  • No new linting warnings introduced
  • No new Dialyzer warnings introduced

Backward Compatibility

  • This change is backward compatible
  • This change includes breaking changes (please describe below)
  • Migration guide provided for breaking changes

Breaking Changes

Performance Impact

  • No performance impact
  • Performance improvement
  • Potential performance regression (please describe)

Performance Notes

Security Considerations

  • No security impact
  • Security improvement
  • Potential security impact (please describe)

Additional Notes

Screenshots/Examples

# Example usage of new feature

Checklist

  • I have read the Contributing Guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Reviewer Notes


@codecov

codecov Bot commented May 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
lib/mix/tasks/permit.install.ex 78.78% <ø> (ø)

... and 5 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@vincentvanbush vincentvanbush force-pushed the patch/revert-igniter-to-optional branch from e660bee to 71d6d3f Compare May 22, 2026 08:36
@vincentvanbush vincentvanbush merged commit 6958689 into master May 22, 2026
16 checks passed
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