Skip to content

Commit

Permalink
Adding more release steps (#679)
Browse files Browse the repository at this point in the history
* Adding more release steps

* Update docs/contributing/README.md

Co-authored-by: Marc Vilanova <[email protected]>

* Update docs/contributing/README.md

Co-authored-by: Marc Vilanova <[email protected]>

Co-authored-by: Marc Vilanova <[email protected]>
  • Loading branch information
kevgliss and mvilanova authored Nov 19, 2020
1 parent ab69505 commit 5148af8
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 5 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ ipython_config.py

# Environments
.env
!data/.env
.venv
env/
venv/
Expand Down
5 changes: 5 additions & 0 deletions data/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# General
LOG_LEVEL=ERROR
STATIC_DIR=""
DATABASE_HOSTNAME=localhost
DATABASE_CREDENTIALS=dispatch:dispatch
46 changes: 41 additions & 5 deletions docs/contributing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,47 @@ Dispatch documentation is managed via Gitbook.

Creating a release of Dispatch requires the following steps.

### Updating sample data

If the database schema changes we will need to update the sample data accordingly.

- Run the Bash script `update-example-data.sh` in the `data` directory.
- Create a commit with any changes
- Create a pull request with the change
- Merge change

### Bumping the version number

* Update the version number in `dispatch/__about__.py`
* Create a new entry in the change log
* Create a commit with the change log changes
* Create a pull request with the change
* Merge change
- Update the version number in `dispatch/__about__.py`
- Create a new entry in the change log
- Create a commit with the change log changes
- Create a pull request with the change
- Merge change

### Change log

- Create a new change log with all major changes since the last release
- Update github releases: https://github.com/Netflix/dispatch/releases
- Publish the release

### Update 'latest' tag

We rely on the latest tag to identify the most current stable version. Follow the steps below to update this tag:

Delete the pervious tag:

```
git tag -d latest
```

Create a new tag:

```
git tag -a latest <commit>
```

Push the tag:

```
git push origin latest
```

0 comments on commit 5148af8

Please sign in to comment.