README

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

Example of a Slack Post

Example of a Conflunce Post

• 1010 MicroService 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?

• [email protected], [email protected]