Update docs#201
Conversation
gomoripeti
force-pushed
the
update_docs
branch
3 times, most recently
from
62dc375 to
7c22d2d
Compare
gomoripeti
force-pushed
the
update_docs
branch
from
7c22d2d to
89aab22
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
This PR is being reviewed by Cursor Bugbot
Details
Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.
To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.
|
|
||
| .PHONY: compile dev dev_back_end dev_front_end npm bootstrap_front_end test_front_end build_prod_front_end test doc gen_ex_doc dialyzer publish | ||
| publish_docs: gen_ex_doc | ||
| ./rebar3 as publish hex docs |
There was a problem hiding this comment.
Hardcoded rebar3 path inconsistent with Makefile pattern
Low Severity
The new publish_docs target uses hardcoded ./rebar3 instead of $(REBAR3). Every other target in the Makefile uses $(REBAR3), which resolves to the system rebar3 or falls back to ./rebar3. This inconsistency means publish_docs will fail for developers who have rebar3 in their PATH but not as a local ./rebar3 file, unlike all other targets including the related publish target which uses $(REBAR3).
gomoripeti
force-pushed
the
update_docs
branch
2 times, most recently
from
a6dd843 to
6b72e80
Compare
- use rebar3_ex_doc plugin to generate documentation - publish to hexdocs
Revert when dropping support for OTP 20
Because the glibc found in erlang-18 to 20 containers is too old to run nodejs 20 github actions. Also don't run json CI tests on OTP 19 only on OTP 21.
- Elixir 1.4 with OTP 18:
runner ubuntu-20.4 is only compatible with OTP 20+
earlier OTP versions fail with:
no match of right hand side value: {:error, {:ssl, {'no such file or directory', 'ssl.app'}}}
running ubuntu-18.4 was removed on 2022.04.03
actions/runner-images#6002
- Elixir 1.5-1.10
runner-24.04 is only compatible with OTP 24.3+
(runner-22.04 is only compatible with OTP 24.2+)
running ubuntu-20.04 was removed on 2025.04.15
actions/runner-images#11101
https://github.blog/changelog/2025-01-15-github-actions-ubuntu-20-runner-image-brownout-dates-and-other-breaking-changes/
- OTP 24 is first supported by Elixir 1.11.4
1 participant
Note
Modernizes documentation generation and publishing across the project.
ex_docwithrebar3_ex_doc; addgen_ex_docandpublish_docstargets using per-apprebar3 ex_doctest_docsGitHub Actions job (OTP 26/Elixir 1.15) to validate docs build; remove inline docs build from test matrixrebar.config(project plugin, ex_doc options, docs profile); update hex plugin tag; dropsyncfrom shell apps{doc, "doc"}toxprof.app.srcand extensive@private/doc comment improvements and minor spec clarifications acrossxprof_coredoc/src/querysyntax.mdWritten by Cursor Bugbot for commit 89aab22. This will update automatically on new commits. Configure here.