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

feat: enable custom replace/pattern for readme versioning #56

Merged
merged 1 commit into from
May 20, 2023
Merged

feat: enable custom replace/pattern for readme versioning #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions lib/git_ops/version_replace.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,20 @@ defmodule GitOps.VersionReplace do
update_file(file, "@version \"#{current_version}\"", "@version \"#{new_version}\"", opts)
end

@spec update_readme(String.t(), String.t(), String.t()) :: String.t() | {:error, :bad_replace}
def update_readme(readme, current_version, new_version, opts \\ []) do
@spec update_readme(
String.t()
| {String.t(), fun :: (String.t() -> String.t()), fun :: (String.t() -> String.t())},
String.t(),
String.t()
) :: String.t() | {:error, :bad_replace}
def update_readme(readme, current_version, new_version, opts \\ [])

def update_readme({readme, replace, pattern}, current_version, new_version, opts)
when is_function(replace, 1) and is_function(pattern, 1) do
update_file(readme, replace.(current_version), pattern.(new_version), opts)
end

def update_readme(readme, current_version, new_version, opts) do
update_file(readme, ", \"~> #{current_version}\"", ", \"~> #{new_version}\"", opts)
end

Expand Down
32 changes: 30 additions & 2 deletions test/version_replace_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@ defmodule GitOps.Test.VersionReplaceTest do
"""
end

def package_json_contents(version) do
"""
{
"version": "#{version}"
}
"""
end

setup do
readme = "TEST_README.md"
version = "0.1.1"
Expand All @@ -30,9 +38,15 @@ defmodule GitOps.Test.VersionReplaceTest do

File.write!(readme, readme_contents)

on_exit(fn -> File.rm!(readme) end)
package_json = "package.json"
File.write!(package_json, package_json_contents(version))

on_exit(fn ->
File.rm!(readme)
File.rm!(package_json)
end)

%{readme: readme, version: version}
%{readme: readme, package_json: package_json, version: version}
end

test "that README gets written to properly", context do
Expand All @@ -54,4 +68,18 @@ defmodule GitOps.Test.VersionReplaceTest do

assert File.read!(readme) == readme_contents(version)
end

test "custom replace/pattern", context do
readme = context.package_json
version = context.version
new_version = "1.0.0"

VersionReplace.update_readme(
{readme, fn v -> "\"version\": \"#{v}\"" end, fn v -> "\"version\": \"#{v}\"" end},
version,
new_version
)

assert File.read!(readme) == package_json_contents(new_version)
end
end