From b17df86ba1d5d2561e055b9ea761c69edb8a77af Mon Sep 17 00:00:00 2001 From: Jeremy Huffman Date: Sat, 8 Apr 2023 06:55:35 -0400 Subject: [PATCH 1/2] Remove out-dated README content. --- README.md | 35 +---------------------------------- 1 file changed, 1 insertion(+), 34 deletions(-) diff --git a/README.md b/README.md index d5c1c0b..7bf652b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Dialyxir -[![Build Status](https://travis-ci.org/jeremyjh/dialyxir.svg?branch=master)](https://travis-ci.org/jeremyjh/dialyxir) [![Module Version](https://img.shields.io/hexpm/v/dialyxir.svg)](https://hex.pm/packages/dialyxir) [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/dialyxir/) [![Total Download](https://img.shields.io/hexpm/dt/dialyxir.svg)](https://hex.pm/packages/dialyxir) @@ -9,28 +8,16 @@ Mix tasks to simplify use of Dialyzer in Elixir projects. -## Changes in 1.0 - -Elixir 1.6 is required, to support the new pretty printing feature. If your -project is not yet on 1.6, continue to specify 0.5 in your mix deps. - -Warning messages have been greatly improved, but are filtered through the legacy formatter to support your existing ignore files. You can optionally use the new Elixir [term format](#elixir-term-format) for ignore files. You may want to use the `--format short` argument in your CI pipelines. There are several formats, also there is a new `explain` feature - for details see CLI [options](#command-line-options). - -## Quickstart -If you are planning to use Dialyzer with an application built with the [Phoenix Framework](http://www.phoenixframework.org/), check out the [Quickstart wiki](https://github.com/jeremyjh/dialyxir/wiki/Phoenix-Dialyxir-Quickstart). - ## Installation Dialyxir is available on [hex.pm](https://hex.pm/packages/dialyxir). -You can either add it as a dependency in your mix.exs, or install it globally as an archive task. - To add it to a mix project, just add a line like this in your deps function in mix.exs: ```elixir defp deps do [ - {:dialyxir, "~> 1.0", only: [:dev], runtime: false}, + {:dialyxir, "~> 1.3", only: [:dev], runtime: false}, ] end ``` @@ -82,26 +69,6 @@ To use Dialyzer in CI, you must be aware of several things: 2) The PLT should be cached using the CI caching system 3) The PLT will need to be rebuilt whenever adding a new Erlang or Elixir version to build matrix -### Travis - -`.travis.yml` -```markdown -language: elixir - -elixir: - - 1.8 - -otp_release: - - 21.0 - -script: - - mix dialyzer - -cache: - directories: - - priv/plts -``` - ### Github Actions `dialyzer.yml` From 77162cfe8761a7f34655883c5a2e5dbee962c6fb Mon Sep 17 00:00:00 2001 From: Jeremy Huffman Date: Sat, 8 Apr 2023 07:12:22 -0400 Subject: [PATCH 2/2] Update version & CHANGELOG for 1.3 release. --- CHANGELOG.md | 16 +++++++++++++++- mix.exs | 2 +- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index dc74518..af3b2d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,8 +4,22 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -## Unreleased changes post [1.2.0] +## Unreleased changes post [1.3.0] +## [1.3.0] - 2023-04-08 + +### Added + - Elixir 1.15 support. + - Support for warning `:callback_not_exported`. + +### Changed + - Several improvements to documentation, particularly Github CI documentation. + +### Removed + - Support for `:race_conditions` flag which was [removed from Erlang](https://github.com/erlang/otp/pull/5502). + +### Fixed + - Crash when `mix.lock` is missing. ## [1.2.0] - 2022-07-20 ### Added diff --git a/mix.exs b/mix.exs index 4370b79..237352d 100644 --- a/mix.exs +++ b/mix.exs @@ -2,7 +2,7 @@ defmodule Dialyxir.Mixfile do use Mix.Project @source_url "https://github.com/jeremyjh/dialyxir" - @version "1.2.0" + @version "1.3.0" def project do [