Skip to content

README documents an appup compiler and mix castle.relup task that no longer live in Castle #9

Description

@ausimian

Problem

The README describes build-time tooling as part of Castle, but that support was moved out to Forecastle in 0.3.0 (see CHANGELOG: "Move build time support into Forecastle"). The repo now contains only lib/castle.ex — there is no Mix compiler and no Mix task (grep for Mix.Task/defmodule Mix.Tasks returns nothing).

Stale sections:

  • "The Appup Compiler" (README ~L81-116) documents adding [:appup] to compilers:, implying the compiler ships in Castle.
  • "Relup Generation" (README ~L118-129): "Castle contains a mix task, castle.relup…" — it does not; mix castle.relup is not defined in this project.
  • Installation (README ~L15-16): "For projects that don't define a release, but use the appup compiler, it's sufficient to bring Castle in as a build-time dependency" — implies the compiler is provided by Castle.

Impact

Users following the README will try to use :appup / mix castle.relup from Castle and find they don't exist, with no pointer to where they actually live.

Suggested fix

Either move these sections to the Forecastle docs and link out from Castle's README, or clearly state that the appup compiler and castle.relup task are provided by Forecastle. Verify which package actually owns each piece and update accordingly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions