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

Initial Elixir API #3

Draft
wants to merge 2 commits into
base: master
from

Conversation

@zachdaniel
Copy link

zachdaniel commented Nov 15, 2019

This is a draft just to confirm the general pattern of the Elixir API as it relates to the erlang API.

mix.exs Show resolved Hide resolved
@tsloughter

This comment has been minimized.

Copy link
Member

tsloughter commented Nov 15, 2019

We should figure out how documentation is going to work. Will we need something custom to wrap around both mix and rebar3 generated docs or can mix generate them all?

@zachdaniel

This comment has been minimized.

Copy link
Author

zachdaniel commented Nov 15, 2019

Thats a great question :)

@zachdaniel

This comment has been minimized.

Copy link
Author

zachdaniel commented Nov 15, 2019

It doesn't look like mix can do it :(

@zachdaniel

This comment has been minimized.

Copy link
Author

zachdaniel commented Nov 15, 2019

You can link to "extra" pages though, so we could potentially just link to the erlang doc pages

@tsloughter

This comment has been minimized.

Copy link
Member

tsloughter commented Nov 19, 2019

We can just generate them to separate sub-directories and have a index.html that links to each.

mix.exs Outdated Show resolved Hide resolved
mix.exs Outdated Show resolved Hide resolved
def project do
[
app: :opentelemetry_api,
version: "0.1.0",

This comment has been minimized.

Copy link
@tsloughter

tsloughter Nov 25, 2019

Member

This is going to be an issue. Either this should be changed to query git for a version like rebar3 does for the .app.src or we should have a VERSION file that both read from.

This comment has been minimized.

Copy link
@zachdaniel

zachdaniel Nov 26, 2019

Author

AFAIK there is nothing built into mix to do that, so a VERSION file sounds like the best choice to me.

This comment has been minimized.

Copy link
@tsloughter

tsloughter Nov 26, 2019

Member

Right, it would have to be functions in mix.exs that do the git commands. But then would also have to have a special pre-publish thing that replaces it with the package version, ugh.

So yea, file sounds like the best choice.

zachdaniel added 2 commits Nov 15, 2019
@zachdaniel zachdaniel force-pushed the zachdaniel:start-elixir-api branch from 59091ed to 06b4ecf Nov 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.