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

Jump to bottom

Execute OTP-specific ex_doc (from priv) #83

Merged
merged 18 commits into from
Mar 7, 2024
Merged

Execute OTP-specific ex_doc (from priv) #83

merged 18 commits into from
Mar 7, 2024

Commits on Mar 4, 2024

  1. Prepare to generate more ex_doc_otp_* (one per major OTP version)

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    39ef507 View commit details
    Browse the repository at this point in the history

  2. Make sure multi-OTP -based releases are now possible 

    The strategy considered is:
1. ask to recreate the _checkouts/rebar3_ex_doc folder
   1.1. this should be done for, e.g., OTP 24 to start
2. don't recreate (further) the _checkouts/rebar3_ex_doc folder
   2.1. continue generation with e.g. OTP 25
3. conditionally download ex_doc from GitHub based on current
   OTP version (e.g. kerl/asdf-activated)

Everything else is pretty much the same, but this commit
also adds a minor change:
- priv/ex_doc_... isn't deleted (it's already ignored and
  is not required to be deleted - maybe a remnant from a
  past iteration?)
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    d2b1da5 View commit details
    Browse the repository at this point in the history

  3. Run CI for a broader OTP/Elixir scope

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    3cce5f2 View commit details
    Browse the repository at this point in the history

  4. Conditionally run ex_doc (escript) from running Erlang/OTP version 

    We choose based on prior downloaded elements
and the fact we know what we're running with
    erlang:system_info(otp_release).
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    ba47934 View commit details
    Browse the repository at this point in the history

  5. Act on CI results: fix GHA workflow

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    e3fd1f9 View commit details
    Browse the repository at this point in the history

  6. Act on CI results: respect lib. declaration of min Elixir vsn

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    ecfcbcc View commit details
    Browse the repository at this point in the history

  7. Act on CI results: don't break Dialyzer 

    "unknown" became a default analysis
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    b24db03 View commit details
    Browse the repository at this point in the history

  8. Temporarily taking OTP 27 out of the loop 

    I want to concentrate on what was working
_before_ 27.0-rc1 came out
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    dec974a View commit details
    Browse the repository at this point in the history

  9. Act on CI results: maybe (?) fix cache path issues

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    cdc35ac View commit details
    Browse the repository at this point in the history

  10. Act on self-review: fix test case 

    It doesn't prevent anything from breaking, but it's
"more correct"
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    5808408 View commit details
    Browse the repository at this point in the history

  11. Adapt more recent dev. software versions

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    706d70b View commit details
    Browse the repository at this point in the history

  12. Reverse "Temporarily taking OTP 27 out of the loop"

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    442c0fd View commit details
    Browse the repository at this point in the history

  13. Allow for current OTP, OTP-1, OTP-2, for compatibility 

    We increase our chances of finding an ex_doc we can use for
a specific OTP
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    8717bb0 View commit details
    Browse the repository at this point in the history

  14. Act on CI results: generate all ex_doc before running CT 

    We limit concurrency so that each "job" fetches the existing
cache to add to it
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    67f65eb View commit details
    Browse the repository at this point in the history

  15. Act on CI results: adapt to upcoming OTP 27 doc. change

    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    f3bd118 View commit details
    Browse the repository at this point in the history

  16. Try to improve on cache save/restore 

    We want to make sure a job uses prior cache in the same
CI run
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    81b29b5 View commit details
    Browse the repository at this point in the history

  17. Target, instead of 27 rc, master/main/nightly 

    Erlang/Elixir/rebar3

This should give us a much more bleeding edge approach, though
it's possible we're increasing the chance of issues

Up to us to decide, later, if we wanna separate this step
into its own workflow which should not be required green
for merge (but kinda seen as a "control" flow)
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    5f0bd1c View commit details
    Browse the repository at this point in the history

  18. Replicate all pre-27 tests as post-27 to adapt input 

    In pre-27 we assume only the tests that existed;
in post-27 we assume all tests that existed plus the same tests
with new input (as post-27 -ready module)
    @paulo-ferraz-oliveira
    paulo-ferraz-oliveira committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    4f18291 View commit details
    Browse the repository at this point in the history