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.

Sign up for GitHub

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

Update option A documentation with needed changes to releases section #139

Merged
merged 3 commits into from
Aug 12, 2022
Merged

Update option A documentation with needed changes to releases section #139

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
698bf4b
Update option A documentation with needed changes to releases section
zaid Jul 28, 2022
32cfba7
Clear-up confusing around app: false / runtime: false
zaid Aug 2, 2022
c4349fa
Note that changes are only needed if we're using releases
zaid Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,22 @@ Then it's necessary to configure the Mix project to not start the `:fun_with_fla
+ {:fun_with_flags, "~> 1.6", runtime: false},
```

If you use releases then you'll also need to modify the `releases` section in `mix.exs` so that it loads the `fun_with_flags` application explicitly (since `runtime: false` / `app: false` will exclude it from the assembled release).

```diff
def project do
[
app: :my_phoenix_app,
+ releases: [
+ my_phoenix_app: [
+ applications: [
+ fun_with_flags: :load
+ ]
+ ]
]
end
```

* **Option B**: Declare that the `:fun_with_flags` application is managed directly by your host application ([docs](https://hexdocs.pm/mix/1.11.3/Mix.Tasks.Compile.App.html)).

```diff
Expand Down