Skip to content

Commit

Permalink
Correct installation instructions & simplify release process (phoenix…
Browse files Browse the repository at this point in the history
…framework#4207)

I have noticed the instructions were wrong because in some files the Phoenix version was not updated,
so we can rely on `mix archive.install` to retrieve the latest version.
  • Loading branch information
eksperimental authored Mar 7, 2021
1 parent 86de573 commit 7ce0ee2
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ You can create a new project using the latest Phoenix source installer (the `phx

1. Remove any previously installed `phx_new` archives so that Mix will pick up the local source code. This can be done with `mix archive.uninstall phx_new` or by simply deleting the file, which is usually in `~/.mix/archives/`.
2. Copy this repo via `git clone https://github.com/phoenixframework/phoenix` or by downloading it
3. Run the `phx.new` mix task from within the `installer` directory, for example:
3. Run the `phx.new` Mix task from within the `installer` directory, for example:

```bash
$ cd installer
$ cd phoenix/installer
$ mix phx.new dev_app --dev
```

Expand Down
2 changes: 0 additions & 2 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,5 @@
* `CHANGELOG`
* `mix.exs`
* `installer/mix.exs`
* `installer/README.md`
* `package.json`
* `assets/package.json`
* `guides/introduction/installation.md`
2 changes: 1 addition & 1 deletion guides/introduction/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Elixir 1.6.3
Once we have Elixir and Erlang, we are ready to install the Phoenix application generator:

```console
$ mix archive.install hex phx_new 1.5.0
$ mix archive.install hex phx_new
```

The `phx.new` generator is now available to generate new applications in the next guide, called [Up and Running](up_and_running.html). The flags mentioned below are command line options to the generator; see all available options by calling `mix help phx.new`.
Expand Down
4 changes: 2 additions & 2 deletions installer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Provides `phx.new` installer as an archive.

To install from hex, run:
To install from Hex, run:

$ mix archive.install hex phx_new 1.5.0
$ mix archive.install hex phx_new

To build and install it locally,
ensure any previous archive versions are removed:
Expand Down
4 changes: 2 additions & 2 deletions installer/mix.exs
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
for path <- :code.get_path,
for path <- :code.get_path(),
Regex.match?(~r/phx_new\-\d+\.\d+\.\d\/ebin$/, List.to_string(path)) do
Code.delete_path(path)
end

defmodule Phx.New.MixProject do
use Mix.Project

@version "1.5.0"
@version "1.6.0-dev"
@github_path "phoenixframework/phoenix"
@url "https://github.com/#{@github_path}"

Expand Down

0 comments on commit 7ce0ee2

Please sign in to comment.