chore: docs/setup for release

This commit is contained in:
Zach Daniel 2023-04-28 14:03:29 -04:00
parent 05c4547015
commit 23f3055fa7
2 changed files with 32 additions and 0 deletions

View file

@ -5,3 +5,20 @@ config :spark, :formatter,
"Ash.Api": [],
"Ash.Registry": [],
"Ash.Resource": []
if Mix.env() == :dev do
config :git_ops,
mix_project: AshOban.MixProject,
changelog_file: "CHANGELOG.md",
repository_url: "https://github.com/ash-project/ash_oban",
# Instructs the tool to manage your mix version in your `mix.exs` file
# See below for more information
manage_mix_version?: true,
# Instructs the tool to manage the version in your README.md
# Pass in `true` to use `"README.md"` or a string to customize
manage_readme_version: [
"README.md",
"documentation/tutorials/get-started-with-ash-oban.md"
],
version_tag_prefix: "v"
end

View file

@ -6,6 +6,21 @@ A trigger describes an action that is run periodically.
This guide will need to be expanded, this is primarily a placeholder with an example.
## Get familiar with Ash resources
If you haven't already, read the [Ash Getting Started Guide](https://hexdocs.pm/ash/get-started.html), and familiarize yourself with Ash and Ash resources.
## Bring in the ash_oban dependency
```elixir
def deps()
[
...
{:ash_oban, "~> 0.1.0"}
]
end
```
## Setup
First, follow the oban setup guide.