Contributing
We're open source! Get started hacking on CBElasticsearch to add a new feature, fix the docs, or prove a regression.
Last updated
Was this helpful?
We're open source! Get started hacking on CBElasticsearch to add a new feature, fix the docs, or prove a regression.
Last updated
Was this helpful?
Follow these steps to get started hacking on CBElasticsearch:
Clone the module - git clone git@github.com:coldbox-modules/cbox-elasticsearch.git
Install dependencies - box install
Start a
Start the cbelasticsearch server - box start
Run tests - box testbox run
To run the test suite you need a running instance of ElasticSearch. We have provided a docker-compose.yml
file in the root of the repo to make this easy as possible. Run docker-compose up --build
( omit the --build
after the first startup ) in the root of the project and open http://localhost:8080/tests/runner.cfm
to run the tests.
If you would prefer to set up Elasticsearch yourself, make sure you start this app with the correct environment variables set:
To issue a new release:
Update (and commit) changelog.md
with each addition, bugfix, or security issue.
These should be placed under the version number heading: ## [x.y.z] - dd-mm-yyyy
. Later this will be automated to use the ## Unreleased
section.
Set and commit the new version number in box.json
, following semantic versioning format.
Run the release script: box recipe build/release.boxr