chore: sync files with stordco/common-config-elixir

Author: github-actions[bot]

.credo.exs

@@ -23,7 +23,7 @@
         # You can give explicit globs or simply directories.
         # In the latter case `**/*.{ex,exs}` will be used.
         #
-        included: ["lib/", "priv/", "test/"],
+        included: ["config/", "lib/", "priv/", "test/"],
         excluded: [~r"/_build/", ~r"/deps/", ~r"/node_modules/"]
       },
       #
@@ -81,7 +81,7 @@
         # You can customize the priority of any check
         # Priority values are: `low, normal, high, higher`
         #
-        {Credo.Check.Design.AliasUsage, [priority: :low, if_nested_deeper_than: 2, if_called_more_often_than: 2]},
+        {Credo.Check.Design.AliasUsage, [priority: :low, if_nested_deeper_than: 4, if_called_more_often_than: 2]},
         {Credo.Check.Design.DuplicatedCode, false},
         # You can also customize the exit_status of each check.
         # If you don't want TODO comments to cause `mix credo` to fail, just
@@ -95,7 +95,8 @@
         #
         {Credo.Check.Readability.AliasAs, false},
         {Credo.Check.Readability.AliasOrder, []},
-        {Credo.Check.Readability.BlockPipe, []},
+        # We previously had this check enabled, but we have agreed to loosen this restriction to allow for more flexibility.
+        # {Credo.Check.Readability.BlockPipe, []},
         {Credo.Check.Readability.FunctionNames, []},
         {Credo.Check.Readability.ImplTrue, []},
         {Credo.Check.Readability.LargeNumbers, [trailing_digits: 2]},
@@ -112,14 +113,17 @@
         {Credo.Check.Readability.RedundantBlankLines, []},
         {Credo.Check.Readability.Semicolons, []},
         {Credo.Check.Readability.SeparateAliasRequire, []},
-        {Credo.Check.Readability.SinglePipe, []},
+        # We previously had this check enabled, but we have agreed to loosen this restriction.
+        # Use common sense, piping a single arg into an arity 1 function like `input |> do_something()` should be avoided.
+        # {Credo.Check.Readability.SinglePipe, []},
         {Credo.Check.Readability.SpaceAfterCommas, []},
         {Credo.Check.Readability.Specs, false},
         {Credo.Check.Readability.StrictModuleLayout,
          [
            order:
              ~w(moduledoc behaviour use import require alias module_attribute defstruct callback macrocallback optional_callback)a,
-           ignore: [:type]
+           ignore: [:type],
+           ignore_module_attributes: [:contract, :decorate, :operation, :trace]
          ]},
         {Credo.Check.Readability.StringSigils, []},
         {Credo.Check.Readability.TrailingBlankLine, []},
@@ -145,7 +149,8 @@
         {Credo.Check.Refactor.NegatedConditionsWithElse, []},
         {Credo.Check.Refactor.NegatedIsNil, []},
         {Credo.Check.Refactor.Nesting, []},
-        {Credo.Check.Refactor.PipeChainStart, []},
+        # We have an exception for `from` which is useful for piping a query into a `Repo` function.
+        {Credo.Check.Refactor.PipeChainStart, [excluded_functions: ["from"]]},
         {Credo.Check.Refactor.UnlessWithElse, []},
         {Credo.Check.Refactor.VariableRebinding, false},
         {Credo.Check.Refactor.WithClauses, []},
@@ -177,7 +182,17 @@
         {Credo.Check.Warning.UnusedPathOperation, []},
         {Credo.Check.Warning.UnusedRegexOperation, []},
         {Credo.Check.Warning.UnusedStringOperation, []},
-        {Credo.Check.Warning.UnusedTupleOperation, []}
+        {Credo.Check.Warning.UnusedTupleOperation, []},
+
+        #
+        ## Custom
+        #
+        {Credo.Check.Warning.ForbiddenModule,
+         [
+           modules: [
+             {Oban.Worker, "use Oban.Pro.Worker instead"}
+           ]
+         ]}
       ]
     }
   ]

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+## Related Ticket(s)
+
+<!--
+Enter the Jira issue below in the following format: PROJECT-##
+-->
+
+## Checklist
+
+<!--
+For each bullet, ensure your pr meets the criteria and write a note explaining how this PR relates. Mark them as complete as they are done. All top-level checkboxes should be checked regardless of their relevance to the pr with a note explaining whether they are relevant or not.
+-->
+
+- [ ] Code conforms to the [Elixir Styleguide](https://github.com/christopheradams/elixir_style_guide)
+
+## Problem
+
+<!--
+What is the problem you're solving or feature you're implementing? Link to any Jira tickets or previous discussions of the issue.
+-->
+
+## Details
+
+<!--
+Include a brief overview of the technical process you took (or are going to take!) to get from the problem to the solution.
+-->

.release-please-config.json renamed to .github/release-please-config-stable.json

@@ -7,6 +7,11 @@
       "section": "Features",
       "hidden": false
     },
+    {
+      "type": "hotfix",
+      "section": "Hotfixes",
+      "hidden": true
+    },
     {
       "type": "fix",
       "section": "Bug Fixes",
@@ -16,15 +21,18 @@
       "type": "chore",
       "section": "Miscellaneous",
       "hidden": false
+    },
+    {
+      "type": "docs",
+      "section": "Miscellaneous",
+      "hidden": false
     }
   ],
   "draft": false,
   "draft-pull-request": false,
   "packages": {
     ".": {
-      "extra-files": [
-        "README.md"
-      ],
+      "extra-files": ["README.md"],
       "release-type": "elixir"
     }
   },