neuralnoise / bulbs-cms-2

An Angular-based CMS for a bulbs-based content system, v2

Bulbs CMS

• Development
  • Local
    • Running
    • Tests
    • Linting
    • Running all code checks
    • Test build
  • Fetching changes from bulbs-cms
  • Creating a new release
    • Create a 'temp' release

_{Note: update table of contents with ./scripts/update-readme-toc}

Development

Local

Running

To run this project locally, based on mocked out data:

$ ./scripts/dev-setup
$ ./scripts/dev-start

Tests

To run tests:

$ ./scripts/test-js

Linting

To run the linter:

$ ./scripts/lint

Running all code checks

To do all code integrity checks, as Travis and the release process will:

$ ./scripts/check-code-integrity

Test build

To check that your changes build cleanly before you do a release:

$ ./scripts/build

Fetching changes from bulbs-cms

This repo should be following the changes in bulbs-cms/relocated-cms until that branch is deleted.

To merge in changes from that branch, first, add the original bulbs-cms repo as a fetch-only remote:

$ git remote add old-bulbs-cms [email protected]:theonion/bulbs-cms.git
$ git remote set-url --push old-bulbs-cms no_push

Verify that your remote urls to old-bulbs-cms are correct:

$ git remote -v
old-bulbs-cms	[email protected]:theonion/bulbs-cms.git (fetch)
old-bulbs-cms	no_push (push)
origin	[email protected]:theonion/bulbs-cms-2.git (fetch)
origin	[email protected]:theonion/bulbs-cms-2.git (push)

Now, to merge in changes from old-bulbs-cms/master into a new branch:

$ git checkout -b <YOUR_BRANCH_NAME>
$ git fetch old-bulbs-cms
$ git merge old-bulbs-cms/master

Resolve any differences, then commit without a message (just use the default message provided):

$ git commit

Then push to your branch:

$ git push

Creating a new release

To create a new release: stop any running build scripts and ensure you're on the master branch, then:

$ ./scripts/tag-and-release <versioning-type>

where versioning-type is one of major, minor, or patch. See semver for an explanation of what each of these types of versionings mean.

This will build, version up, and push the dist to a tag identified by the new version.

Create a 'temp' release

To create a tag not associated with any particular version run:

$ ./scripts/tag-and-release temp

This will build and push the dist to a tag identified by temp-<last commit hash>-<current branch name>.

Use this in situations where you need to point someone else to a distribution for some analysis or testing.