Trying to fix README formatting.
This commit is contained in:
parent
7762fb1228
commit
c2da051878
46
README.md
46
README.md
@ -7,38 +7,38 @@ Script to extract data from JIRA and pull it into a postgres DB for analysis.
|
|||||||
3. [Generate an API token for your JIRA user.][jira-api-key]
|
3. [Generate an API token for your JIRA user.][jira-api-key]
|
||||||
4. Pull the database container:
|
4. Pull the database container:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make createdb
|
make createdb
|
||||||
```
|
```
|
||||||
|
|
||||||
Feel free to edit the Makefile to view or change the default
|
Feel free to edit the Makefile to view or change the default
|
||||||
username/password combination.
|
username/password combination.
|
||||||
|
|
||||||
4. Build the tool:
|
5. Build the tool:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
nimble build
|
nimble build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
- Start the database container:
|
- Start the database container:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make startdb
|
make startdb
|
||||||
```
|
```
|
||||||
|
|
||||||
- Pull issues from your JIRA instance into the DB:
|
- Pull issues from your JIRA instance into the DB:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./jira_analysis api-sync <jira-base-url> <username> <api-token>
|
./jira_analysis api-sync <jira-base-url> <username> <api-token>
|
||||||
```
|
```
|
||||||
|
|
||||||
- Connect to the database for analysis:
|
- Connect to the database for analysis:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
make connect
|
make connect
|
||||||
```
|
```
|
||||||
|
|
||||||
## Convenient PostgreSQL commands
|
## Convenient PostgreSQL commands
|
||||||
|
|
||||||
@ -46,11 +46,11 @@ From within a `psql` session:
|
|||||||
|
|
||||||
- Export tables to CSV:
|
- Export tables to CSV:
|
||||||
|
|
||||||
```psql
|
```psql
|
||||||
\copy features TO features-export.csv DELIMITER ',' CSV HEADER;
|
\copy features TO features-export.csv DELIMITER ',' CSV HEADER;
|
||||||
\copy issues TO issues-export.csv DELIMITER ',' CSV HEADER;
|
\copy issues TO issues-export.csv DELIMITER ',' CSV HEADER;
|
||||||
\copy change_logs TO changelog-export.csv DELIMITER ',' CSV HEADER;
|
\copy change_logs TO changelog-export.csv DELIMITER ',' CSV HEADER;
|
||||||
```
|
```
|
||||||
|
|
||||||
[docker-desktop]: https://www.docker.com/products/docker-desktop
|
[docker-desktop]: https://www.docker.com/products/docker-desktop
|
||||||
[nimlang]: https://nim-lang.org/
|
[nimlang]: https://nim-lang.org/
|
||||||
|
Loading…
Reference in New Issue
Block a user