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

Add mix.exs #99

Merged
merged 2 commits into from Oct 21, 2021
Merged

Add mix.exs #99

merged 2 commits into from Oct 21, 2021

Conversation

josevalim
Copy link
Contributor

@josevalim josevalim commented Oct 20, 2021

This allows Elixir to compile the project without shelling
out to Rebar3, which is useful in low memory environments.
Generally speaking, I would say this is not a requirement for
projects, but given telemetry usage is widespread, it makes
sense to optimize it to different build tools.

The only downside is that the vsn can no longer be hardcoded
to "git". For this reason, we also introduce a "RELEASE.md"
file with steps to release a new version (which already
requires some extra steps due to the use of ExDoc for docs).

This allows Elixir to compile the project without shelling
out to Rebar 3, which is useful in low memory environments.
Generally speaking, I wouldn't say this is a requirement for
projects, but given telemetry usage is widespread, it makes
sense to optimize it to different build tools.

The only downside is that the vsn can no longer be hardcoded
to "git". For this reason, we also introduce a "RELEASE.md"
file with steps to release a new version (which already
requires some extra steps due to the use of ExDoc for docs).
RELEASE.md Outdated
2. Update version in `docs.sh`
3. Run `./docs.sh`
4. Run `rebar3 hex publish`
5. Run `rebar3 hex docs`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arkgil can you please confirm these steps are correct?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both rebar commands need to be run as docs. Otherwise looks good - we'll update on the next release of it's not accurate 😅

RELEASE.md Outdated Show resolved Hide resolved
@josevalim
Copy link
Contributor Author

@arkgil other than that, are you happy with this? If so, can I get your seal of approval? :)

@arkgil
Copy link
Contributor

arkgil commented Oct 21, 2021

Granted!

image

@josevalim josevalim merged commit 9a9da7b into main Oct 21, 2021
@josevalim
Copy link
Contributor Author

💚 💙 💜 💛 ❤️

@josevalim josevalim deleted the jv-mix-exs branch October 21, 2021 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants