diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d6919e4..71e8ba2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -22,7 +22,7 @@ A list of software versions where the bug is apparent, as detailed as possible: An ordered list of steps to replicate the bug: -1. run `rebar3 ci` +1. run `rebar3 as test ci` 2. search for `...` in the error output 3. look at file `...` diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ba60562..523feef 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -52,3 +52,6 @@ jobs: - name: Continuous Integration run: | rebar3 as test ci + + - name: Check if build left artifacts + run: git diff --exit-code diff --git a/.gitignore b/.gitignore index 1002e04..776f794 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ _build doc/ erl_crash.dump rebar3.crashdump +rebar.lock diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d4caaa..4e672fb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,8 +20,9 @@ Bugs can be reported via [GitHub issues: bug report](https://github.com/arizona-framework/arizona_example/issues/new?template=bug_report.md). -Some contributors and maintainers may be unpaid developers working on `arizona_example`, in their own time, -with limited resources. We ask for respect and understanding, and will provide the same back. +Some contributors and maintainers may be unpaid developers working on `arizona_example`, in their +own time, with limited resources. We ask for respect and understanding, and will provide the same +back. If your contribution is an actual bug fix, we ask you to include tests that, not only show the issue is solved, but help prevent future regressions related to it. @@ -30,8 +31,8 @@ is solved, but help prevent future regressions related to it. Before requesting or implementing a new feature, do the following: -- search, in existing [issues](https://github.com/arizona-framework/arizona_example/issues) (open or closed), -whether the feature might already be in the works, or has already been rejected, +- search, in existing [issues](https://github.com/arizona-framework/arizona_example/issues) (open or +closed), whether the feature might already be in the works, or has already been rejected, - make sure you're using the latest software release (or even the latest code, if you're going for _bleeding edge_). @@ -40,8 +41,8 @@ If this is done, open up a We may discuss details with you regarding the implementation, and its inclusion within the project. -We try to have as many of `arizona_example`'s features tested as possible. Everything that a user can do, -and is repeatable in any way, should be tested, to guarantee backwards compatible. +We try to have as many of `arizona_example`'s features tested as possible. Everything that a user +can do, and is repeatable in any way, should be tested, to guarantee backwards compatible. ## Submitting your changes diff --git a/rebar.config b/rebar.config index f4231ff..a27c3ad 100644 --- a/rebar.config +++ b/rebar.config @@ -29,8 +29,6 @@ {alias, [ {ci, [ - {unlock, "--all"}, - {upgrade, "--all"}, lint, {do, "default as test xref"}, {do, "default as test dialyzer"}, diff --git a/rebar.lock b/rebar.lock deleted file mode 100644 index b50d811..0000000 --- a/rebar.lock +++ /dev/null @@ -1,24 +0,0 @@ -{"1.2.0", -[{<<"arizona">>, - {git,"https://github.com/arizona-framework/arizona", - {ref,"96dbd6d6542c8ae85fd5a15046da5cdd35dae1f7"}}, - 0}, - {<<"cowboy">>,{pkg,<<"cowboy">>,<<"2.12.0">>},1}, - {<<"cowlib">>,{pkg,<<"cowlib">>,<<"2.13.0">>},2}, - {<<"fs">>,{pkg,<<"fs">>,<<"8.6.1">>},1}, - {<<"gproc">>,{pkg,<<"gproc">>,<<"1.0.0">>},1}, - {<<"ranch">>,{pkg,<<"ranch">>,<<"1.8.0">>},2}]}. -[ -{pkg_hash,[ - {<<"cowboy">>, <<"F276D521A1FF88B2B9B4C54D0E753DA6C66DD7BE6C9FCA3D9418B561828A3731">>}, - {<<"cowlib">>, <<"DB8F7505D8332D98EF50A3EF34B34C1AFDDEC7506E4EE4DD4A3A266285D282CA">>}, - {<<"fs">>, <<"7C9C0D0211E8C520E4E9EDA63B960605C2711839F47285E6166C332D973BE8EA">>}, - {<<"gproc">>, <<"AA9EC57F6C9FF065B16D96924168D7C7157CD1FD457680EFE4B1274F456FA500">>}, - {<<"ranch">>, <<"8C7A100A139FD57F17327B6413E4167AC559FBC04CA7448E9BE9057311597A1D">>}]}, -{pkg_hash_ext,[ - {<<"cowboy">>, <<"8A7ABE6D183372CEB21CAA2709BEC928AB2B72E18A3911AA1771639BEF82651E">>}, - {<<"cowlib">>, <<"E1E1284DC3FC030A64B1AD0D8382AE7E99DA46C3246B815318A4B848873800A4">>}, - {<<"fs">>, <<"61EA2BDAEDAE4E2024D0D25C63E44DCCF65622D4402DB4A2DF12868D1546503F">>}, - {<<"gproc">>, <<"109F253C2787DE8A371A51179D4973230CBEC6239EE673FA12216A5CE7E4F902">>}, - {<<"ranch">>, <<"49FBCFD3682FAB1F5D109351B61257676DA1A2FDBE295904176D5E521A2DDFE5">>}]} -].