homerun-ats-theme v1.0.2

homerun-ats-theme

Common styles for Homerun ATS products

Usage

In the project where you can make use of this theme, run:

yarn add "ssh://git@github.com:homerunco/homerun-ats-theme#vX.X.X"

Where vX.X.X is the version you want to install. Check https://github.com/homerunco/homerun-ats-theme/releases for latest releases.

In your SCSS files, import the needed files like this:

@import "~homerun-ats-theme/src/reset";
@import "~homerun-ats-theme/src/bootstrap";
@import "~homerun-ats-theme/src/base/base";

post-css variables are also available. In your postcss.config.js do:

module.exports = {
  ident: 'postcss',
  plugins: [
    ...
    require('postcss-advanced-variables')({
      variables: require('homerun-ats-theme/src/base/variables.js'),
    }),
    ...
  ]
}

Development

If you want to make changes to the theme, clone this repository next to your project and run:

yarn add "link:./../homerun-ats-theme"

Changes made in this folder will be reflected in your project.

Publish a new version

To publish a new version of the theme, you can make use of Ted The Releaser. ted-the-releaser is a CLI tool that will determine the next release tag, show the changelog and ask for confirmation before releasing. It will also create a GitHub release containing the changelog based on the commit messages. Install it with npm install -g @homerun/ted-the-releaser and then run ted release every time you want to create a release.

If you are not a fan of Node CLI tools, Ted refuses to work or you are away from your laptop, you can still create releases using git tags:

• On your terminal, checkout latest changes on master (git checkout master && git pull && git fetch --all) and create a tag with git tag vX.X.X. Make sure you specify the correct version. Push the changes with git push --follow-tags and it will trigger a release via CI.
• On GitHub, you can create a tag using their releases feature interface. Again, make sure you specify the correct tag. Release title and description are optional.