Haxe Code Cookbook
Haxe programming cookbookOtherPublish to Haxelib using Travis and Github Releases

Publish to Haxelib using Travis and Github Releases

Reading time: 2.5 minutes

This tutorial will help you publish your library automatically to lib.haxe.org when you create a release on GitHub.

Motivation

This may seen as quite some steps, in reality it will make your life much easier and has great advantages:

  • Collaborators on GitHub can help publish on haxelib without the need of sharing/knowing your password.
  • It automatically tests your project (even on each build, even for each pull request you might get), this helps to not accidentally publish broken builds.
  • You can just make a release using the GitHub website.
  • It makes sure you have tagged your projects. Because that's what GitHub does for you when doing a release.
  • It is more transparent for collaborators/users what goes into the haxelib package zip file.
  • It will make you look 36% more professional.

What do you need

  • GitHub account and basic knowledge how to use Git.
  • A Travis account. You can create one by linking your GitHub profile.
  • A Haxelib account. If you have Haxe installed, you can run command-line: haxelib register. Remember your password.

Getting started

Create a (useful) project and push it to GitHub.

Add haxelib.json

Create and push haxelib.json. This is your configuration for Haxelib projects.

{
  "name": "LIBNAME",
  "url": "https://github.com/GITHUB_USERNAME/LIBNAME",
  "license": "MIT",
  "tags": [],
  "description": "Cool Project",
  "version": "0.0.1",
  "classPath": "src/",
  "releasenote": "Initial release",
  "contributors": ["markknol"],
  "dependencies": {
    
  }
}

Add .travis.yml

Create and push .travis.yml. This is your configuration for Travis.

sudo: required
dist: trusty

language: haxe

haxe:
 - "3.4.7"
 - "development"

install:
 - haxelib dev LIBNAME .

script:
 - haxe test.hxml

deploy:
 - provider: script
   haxe: 3.4.7
   script: bash ./release_haxelib.sh $HAXELIB_PWD
   on:
	 tags: true

Add release_haxelib.sh

Create and push release_haxelib.sh. This is a bash file that Travis will run to deploy to Haxelib.

Leave $HAXELIB_PWD like this, we will give Travis the password in a private/secure way.

As you can see, it creates a zip which will be send to Haxelib. This zip includes the src-folder, all markdown files, json files and hxml files and run file (if present). You can customize this to your needs.

#!/bin/sh
rm -f library.zip
zip -r library.zip src *.md *.json *.hxml run.n
haxelib submit library.zip $HAXELIB_PWD --always

On GitHub: Enable travis

On Travis: Enable travis for project

  • You need to have your GitHub account synced to Travis.
  • Go to https://travis-ci.org/profile/GITHUB_USERNAME
  • Press "Sync account" this will update the repositories list.
  • Find the GitHub repository in the list, enable the project (make option ✓)

On Travis: Configure the settings

Publish to Haxelib

Assuming your project is good to go, you can now publish to Haxelib.

New Haxelib users

If you never ever published to Haxelib before; welcome to haxelib! Unfortunatly, your first release should be done by hand.

Run from commandline (bash):

zip -r library.zip src *.md *.json *.hxml run.n
haxelib submit library.zip

If you are using Git Bash on Windows, install Zip for Git Bash extension first.
If the zip command doesn't work for you, just create the zip however you want. As you can see, it includes the src-folder and some other file extensions. Customize it to your needs.

Release steps

These are the release steps you need to take from now on:

  1. Update haxelib.json: Change releasenotes and raise the version. Note, Haxelib uses SemVer.
  2. GitHub > Releases > Make new release https://github.com/GITHUB_USERNAME/LIBNAME/releases/new
  3. Enter release information:

    • Tag name should be same as version in haxelib.json
    • Add release notes
    • Press "Publish release"
  4. Wait for Travis

  5. Check if it actually released the project https://lib.haxe.org/recent/. Congrats, your library is published.

Optional fun

  • Add a Travis badge to your README.md. This is the markdown you need for that.
[![Build Status](https://travis-ci.org/GITHUB_USERNAME/LIBNAME.svg?branch=master)](https://travis-ci.org/GITHUB_USERNAME/LIBNAME)
  • Since you now have automatic deployment, you also have automated testing. You can add more tests.

Enjoy automated deploys!


Contributors:
Last modified:
Created:
Category:  Other