typelead / etlas-index

Index for Etlas, the Eta Package Repository

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Index for Etlas, the Eta Package Repository

Quick Jump

Package Listing

Submitting a Package

Suppose you want to upload a package you've written, somepackage-0.1.0.1 to the Etlas repo.

  1. Decide the name of tag you want to create for you release, but do not create it yet. We'll refer to this as [tag]. This will mostly be the version of the package you want to release, so in this case it can be 0.1.0.1, v0.1.0.1, or any convention that suits you.

  2. Add the following section to your Cabal file:

source-repository this
  type: git
  location: [location]
  tag: [tag]
  • [location] - Url of the repository
  • [tag] - Mentioned in (1)
  1. Commit & push your changes.
git add somepackage.cabal
git commit -m "[commit-msg]"
git push
  • [commit-msg] - Commit message of your choice, something like "Releasing somepackage-0.1.0.1".
  1. Create & push the tag.
git tag [tag]
git push --tags
  1. If you haven't already, fork this repo and clone it locally.

  2. Create a new branch with the name of your package.

git checkout -b somepackage-0.1.0.1
  1. Copy the Cabal file from (2) into packages/somepackage/0.1.0.1/somepackage.cabal.

  2. Add a new entry into the 00-index.tar file (you can open it in a text editor):

pkg: somepackage 0.1.0.1 p# packages/somepackage/0.1.0.1/somepackage.cabal
  1. Add an entry for your package to the listing in README.md.

  2. Commit & push your changes.

git add .
git commit -m "Releasing somepackage-0.1.0.1"
git push
  1. Submit a pull request to this repo.

Regenerating Index

You can run

etlas run ./scripts

to regenerate the index.

About

Index for Etlas, the Eta Package Repository


Languages

Language:Haskell 100.0%