# changelog-1010

> Some preliminary code that will allow us to generate a changelog and publish it to Slack and Confluence

Latest version **1.0.7** (published 2020-10-21) · 0 weekly downloads

## Install

```sh
npm install changelog-1010
pnpm add changelog-1010
yarn add changelog-1010
bun add changelog-1010
```

Provides the command `generateChangelog`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score; declining downloads.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2020-10-21 |
| First published | 2020-09-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 193.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | danielle.delooze |

## Links

- npm: https://www.npmjs.com/package/changelog-1010
- npm.io page: https://npm.io/package/changelog-1010

## Dependencies (2)

- [confluence-api](https://npm.io/package/confluence-api.md) 1.4.0
- [jira-changelog](https://npm.io/package/jira-changelog.md) 1.4.1

## Recent versions

- 1.0.7 (latest) — 2020-10-21
- 1.0.6 — 2020-09-15
- 1.0.5 — 2020-09-15
- 1.0.4 — 2020-09-15
- 1.0.2 — 2020-09-15
- 1.0.3 — 2020-09-15
- 1.0.1 — 2020-09-14
- 1.0.0 — 2020-09-14

## README

# README #

Some preliminary code that will allow us to generate a changelog and publish it to Slack and 
Confluence

### Example of a Slack Post ###
![Drag Racing](slack.jpg)

### Example of a Conflunce Post ###
* [1010 MicroService Changelog](https://1010data.atlassian.net/wiki/spaces/ORCH/pages/441057429/Orchestrator+Changelog)

### How do I get set up? ###
* Create a slack bot to get a slack api key and install in in your channel you wish to post the changelog to
* Get a pair of credentials for an atlassian account. This is needed to parse out jira issues and post to conflunce. 

* Evironment variables
    * ATLASSIAN_HOST (default 1010data.atlassian.net)
    * ATLASSIAN_USERNAME (service account username)
    * ATLASSIAN_PASSWORD (Service account password)
    * SLACK_API_KEY
    * SLACK_CHANNEL
    * SLACK_USERNAME
    * CONFLUENCE_PAGEID
    * CONFLUENCE_SPACE
    * RANGE_FROM
    * RANGE_TO

#### How do i run it manually? ####
* add this code (catapult/changelog) to your repo for which you want to generate the changelog
* `cd changelog`
* `npm install`
* `git fetch origin`
* `git fetch --tags --all -f`
* Set the env variable for the two tags/ branches you want to create a changelog between
    * Example that gets the last two tags
    
    ```
    export RANGE_FROM=$(git describe --abbrev=0 --tags `git rev-list --fir    st-parent origin/master --skip=1 --max-count=1`)

    export RANGE_TO=$(git describe --abbrev=0 --tags `git rev-list --first    -parent origin/master --skip=0 --max-count=1`)
    ```
* `npm run-script run_changelog`

### How do i add this to my bitbucket pipeline? ###
```
 tags:
   '**':
     - step:
         name: Changelog
         image: node:10.15.3
         clone:
           depth: full
         caches:
           - node
         script:
           - npm install changelog-1010
           - git fetch origin
           - git fetch --tags --all -f
           - export RANGE_FROM=$(git describe --abbrev=0 --tags `git rev-list --fir    st-parent origin/master --skip=1 --max-count=1`)
           - export RANGE_TO=$(git describe --abbrev=0 --tags `git rev-list --first    -parent origin/master --skip=0 --max-count=1`)
           - node ./node_modules/changelog-1010/run_changelog.js
```

### Who do I talk to? ###
* sachet.patil@1010data.com, danielle.delooze@1010data.com

---
_Source: https://npm.io/package/changelog-1010 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._