drone-ui

README

Drone UI

Getting started

1. Clone this repository

   git clone https://github.com/drone/drone-ui.git
   

2. Install dependencies

   npm install
   

3. Copy .env.example and rename it into .env

   cp .env.example .env.development.local
   

4. Fill required variables. For example:

   REACT_APP_DRONE_SERVER=https://drone.company.com
   REACT_APP_DRONE_TOKEN=<your_drone_token>
   

Run the app

npm run start

Build the app

npm run build

Run the built app

npm run serve

Run linters

npm run lint

Run linters and fix auto fixable problems

npm run lint:fix

Run your tests

npm run test

Commits

We use Conventional Commits for commit messages. You can read more about Conventional Commits here. Here you can find a useful Conventional Commits Cheat Sheet.

We try to make our commits "atomic". Here and here you can read more about Atomic commits.

Release procedure

Run the changelog generator.

docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u drone -p drone-ui -t <secret github token>

You can generate a token by logging into your GitHub account and going to Settings -> Personal access tokens.

Next we tag the PR's with the fixes or enhancements labels. If the PR does not fufil the requirements, do not add a label.

** Before moving on make sure to update the version in package.json. **

Run the changelog generator again with the future version according to semver.

docker run -it --rm -v "$(pwd)":/usr/local/src/your-app githubchangeloggenerator/github-changelog-generator -u drone -p drone-ui -t <secret token> --future-release v1.0.0

Create your pull request for the release. Get it merged then tag the release.

Please reference the updated changelog in your PR to update Drone with the latest UI SHA.