Specs

compatibility({:elixir, :otp}) :: %{
  required(elixir_version_key()) => [otp_version_key(), ...]
}

compatibility({:otp, :elixir}) :: %{
  required(otp_version_key()) => [elixir_version_key(), ...]
}

Returns a compatibilty table between Elixir and Erlang/OTP, and viceversa.

The information provided is based on the page Compatibility between Elixir and Erlang/OTP.

Examples

> BeamLangsMetaData.compatibility({:elixir, :otp})
%{
  "1.0" => [17],
  "1.0.5" => [17, 18],
  "1.1" => [17, 18],
  "1.10" => [21, 22],
  "1.10.3" => [21, 22, 23],
  "1.11" => [21, 22, 23],
  "1.11.4" => [21, 22, 23, 24],
  "1.12" => [22, 23, 24],
  "1.13" => [22, 23, 24],
  ...
}

> BeamLangsMetaData.compatibility({:elixir, :otp})
%{
  17 => ["1.0", "1.1"],
  18 => ["1.0.5", "1.1", "1.2", "1.3", "1.4", "1.5"],
  19 => ["1.2.6", "1.3", "1.4", "1.5", "1.6", "1.7"],
  20 => ["1.4.5", "1.5", "1.6", "1.7", "1.8", "1.9"],
  21 => ["1.10", "1.11", "1.6", "1.7", "1.8", "1.9"],
  22 => ["1.10", "1.11", "1.12", "1.13", "1.7", "1.8", "1.9"],
  23 => ["1.10.3", "1.11", "1.12", "1.13"],
  24 => ["1.11.4", "1.12", "1.13"]
}

Specs

elixir_releases() ::
  nonempty_keyword(
    major_minor_version :: atom(),
    %{
      latest: version_string(),
      releases:
        nonempty_keyword(elixir_version :: atom(), elixir_release_data())
    }
  )

Returns Elixir releases data, including final and pre-releases.

The data is a stripped down version of the Elixir releases JSON files from GitHub, decoded into a list of maps.

NOTE: The information that gets updated in run time is removed such as number of downloads and reactions. Currently "updated_at" is also removed, but it will be included when a mechanism to check for udpated in any part of the JSON files is implemented. As of now, only the new entries are added to this functions, so if there is any correction in a previously entered entry it will not be updated.

The sources of this data can be found https://api.github.com/repositories/1234714/releases?page=1.

Examples

> BeamLangsMetaData.elixir_releases()
[
  "1.13": %{
    latest: "1.13.0",
    releases: [
      "1.13.0": %{
        assets: [
          %{
            content_type: "application/zip",
            created_at: "2021-12-03T18:25:36Z",
            download_url:
              "https://github.com/elixir-lang/elixir/releases/download/v1.13.0/Precompiled.zip",
            id: 50_943_934,
            label: nil,
            name: "Precompiled.zip",
            node_id: "RA_kwDOABLXGs4DCVe-",
            size: 6_230_020,
            state: "uploaded",
            url: "https://api.github.com/repos/elixir-lang/elixir/releases/assets/50943934"
          },
          %{
            content_type: ...,
            created_at: ...,
            download_url: ...,
            id: ...,
            label: ...,
            name: ...,
            node_id: ...,
            size: ...,
            state: ...,
            url: ...
          }
        ],
        assets_url: "https://api.github.com/repos/elixir-lang/elixir/releases/54599470",
        body:
          "Announcement: https://elixir-lang.org/blog/2021/12/03/elixir-v1-13-0-released/\r\n\r\n" <> ...,
        created_at: "2021-12-03T18:03:54Z",
        draft: false,
        id: 54_599_470,
        name: "1.13.0",
        node_id: "RE_kwDOABLXGs4DQR8u",
        prerelease: false,
        published_at: "2021-12-03T18:25:51Z",
        release_url: "https://github.com/elixir-lang/elixir/releases/tag/v1.13.0",
        tag_name: "v1.13.0",
        tarball_url: "https://api.github.com/repos/elixir-lang/elixir/tarball/v1.13.0",
        target_commitish: "main",
        upload_url:
          "https://uploads.github.com/repos/elixir-lang/elixir/releases/54599470/assets{?name,label}",
        url: "https://api.github.com/repos/elixir-lang/elixir/releases/54599470",
        zipball_url: "https://api.github.com/repos/elixir-lang/elixir/zipball/v1.13.0"
      },
      "1.13.0-rc.1": %{
        assets: [
          %{...},
          %{...},
        ],
        assets_url: ...,
        body: ...,
        created_at: ...,
        draft: ...,
        id: ...,
        name: ...,
        node_id: ...,
        prerelease: ...,
        published_at: ...,
        release_url: ...,
        tag_name: ...,
        tarball_url: ...,
        target_commitish: ...,
        upload_url: ...,
        url: ...,
        zipball_url: ...
      },
      "1.13.0-rc.0": %{...}
    ]
  },
  "1.12": %{
    latest: "1.12.3",
    releases: [
      "1.12.3": %{
        assets: [
          %{...},
          %{...}
        ],
        assets_url: ...,
        body: ...,
        created_at: ...,
        draft: ...,
        id: ...,
        name: ...,
        node_id: ...,
        prerelease: ...,
        published_at: ...,
        release_url: ...,
        tag_name: ...,
        tarball_url: ...,
        target_commitish: ...,
        upload_url: ...,
        url: ...,
        zipball_url: ...
      },
      "1.12.2": %{...},
      "1.12.1": %{...},
      "1.12.0": %{...},
      "1.12.0-rc.1": %{...},
      "1.12.0-rc.0": %{...},
    ]
  },
  "1.11": %{
    latest: "1.11.4",
    releases: [...],
  },
  ...,
 "1.0": %{
    latest: "1.0.5",
    releases: [...],
  }
]

Specs

otp_releases() ::
  nonempty_keyword(
    major_version :: atom(),
    %{
      latest: otp_version(),
      releases: nonempty_keyword(otp_version :: atom(), otp_release_data())
    }
  )

Returns Erlang/OTP releases data, including final and pre-releases.

Examples

> BeamLangsMetaData.otp_releases()
[
  "24": %{
    latest: "24.2.1",
    releases: [
      "24.2.1": %{
        assets: [
          %{
            content_type: "text/plain",
            created_at: "2022-01-25T17:22:17Z",
            download_url: "https://github.com/erlang/otp/releases/download/OTP-24.2.1/SHA256.txt",
            id: 54_929_204,
            label: "",
            name: "SHA256.txt",
            node_id: "RA_kwDOAAW4j84DRic0",
            size: 347,
            state: "uploaded",
            url: "https://api.github.com/repos/erlang/otp/releases/assets/54929204"
          },
          %{
            content_type: "application/x-msdownload",
            created_at: ...,
            download_url: "https://github.com/erlang/otp/releases/download/OTP-24.2.1/otp_win64_24.2.1.exe",
            id: ...,
            label: "",
            name: "otp_win64_24.2.1.exe",
            node_id: ...,
            size: ...,
            state: ...,
            url: ...
          },
          ...
        ],
        assets_url: "https://api.github.com/repos/erlang/otp/releases/57941240",
        body:
          "```\nPatch Package:           OTP 24.2.1\nGit Tag:" <> ...,
        created_at: "2022-01-22T08:41:48Z",
        draft: false,
        id: 57_941_240,
        name: "24.2.1",
        node_id: "RE_kwDOAAW4j84DdBz4",
        prerelease: false,
        published_at: "2022-01-25T17:12:12Z",
        release_url: "https://github.com/erlang/otp/releases/tag/OTP-24.2.1",
        tag_name: "OTP-24.2.1",
        tarball_url: "https://api.github.com/repos/erlang/otp/tarball/OTP-24.2.1",
        target_commitish: "master",
        upload_url:
          "https://uploads.github.com/repos/erlang/otp/releases/57941240/assets{?name,label}",
        url: "https://api.github.com/repos/erlang/otp/releases/57941240",
        zipball_url: "https://api.github.com/repos/erlang/otp/zipball/OTP-24.2.1"
      },
      "24.2": %{
        assets: [
          %{...},
          ...
        ],
        assets_url: ...,
        body: ...,
        created_at: ...,
        draft: ...,
        id: ...,
        name: ...,
        node_id: ...,
        prerelease: ...,
        published_at: ...,
        release_url: ...,
        tag_name: ...,
        tarball_url: ...,
        target_commitish: ...,
        upload_url: ...,
        url: ...,
        zipball_url: ...
      },
      "24.1.7": %{...},
      "24.1.6": %{...},
      ...,
      "24.0": %{...},
      "24.0-rc3": %{...},
      ...
    ]
  },
  "23": %{
    latest: "23.3.4",
    releases: [...]
  },
  ...
]