Giter VIP home page Giter VIP logo

ci's Introduction

Atom Package CI Scripts

Templates for building your Atom package and running its specs:

Setting up CI for your package

Travis CI

  • Sign up for an account on Travis CI
  • Copy .travis.yml to the root of your package's repository
  • Setup the Travis CI hook on your package's repository
  • ๐Ÿ’ฅ Your package will now build and run its specs; you can see an example of a configured package here

Appveyor

  • Sign up for an account on Appveyor
  • Add a new project
  • Ensure the Ignore appveyor.yml setting in Settings > General is unchecked
  • Copy appveyor.yml to the root of your package's repository
  • ๐Ÿ’ฅ Your package will now build and run its specs; you can see an example of a configured package here

CircleCI

  • Sign up for an account on CircleCI
  • Create a .circleci directory at the root of your project
  • Copy config.yml to the new directory
  • Commit the changes and push them up to GitHub
  • Add a new project on CircleCI
  • ๐Ÿ’ฅ Your package will now build and run its specs; you can see an example of a configured package here

FAQ

How do I install other Atom packages that my package build depends on?

Set the APM_TEST_PACKAGES environment variable in your .travis.yml or .circleci/config.yml file to a space-separated list of packages to install before your package's tests run.

env:
  - APM_TEST_PACKAGES="autocomplete-plus some-other-package-here"

What version of Atom is used to run the specs?

It will always download the latest available version. You can read more about the latest Atom release here.

How does it work?

The apm test command assumes your package is using Jasmine specs. You can run the specs locally using Atom's spec runner UI from the View > Developer > Run Package Specs menu or by pressing cmd-ctrl-alt-p. You can run apm help test to learn more about that command.

Travis CI

The .travis.yml template downloads the build-package.sh from this repository. This script then downloads the latest Atom release, installs your package's dependencies, and runs the apm test command to run your package's specs.

Appveyor

The appveyor.yml template uses Chocolatey to download and install the latest version of Atom. apm install is run in your package directory to ensure any node dependencies are available. Finally, the script runs the apm test command to run your package's specs.

CircleCI

The .circleci/config.yml template runs the same script that is used in the Travis-CI builds.

What does the output look like?

What packages use this?

ci's People

Contributors

50wliu avatar arcanemagus avatar binarymuse avatar damieng avatar daviwil avatar felicianotech avatar fscherwi avatar iolsen avatar izuzak avatar jasonrudolph avatar joefitzgerald avatar joshaber avatar kevinji avatar kevinsawicki avatar kn1kn1 avatar lee-dohm avatar levlaz avatar markushedvall avatar maxbrunsfeld avatar mnquintana avatar peterdavehello avatar smashwilson avatar stdavis avatar steelbrain avatar thomasjo avatar tnm avatar tonylukasavage avatar torn4dom4n avatar uzitech avatar xfq avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.