Create changelog orb (#1)

ory · Jan 6, 2020 · 7397c6b · 7397c6b
1 parent 0dc12b0
commit 7397c6b
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 103 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -2,50 +2,13 @@ version: 2.1
 description: Creates and updates the CHANGELOG.md file
 
 orbs:
-  changelog:
-    executors:
-      changelog:
-        docker:
-          -
-            image: circleci/ruby:2.5-node
-    jobs:
-      changelog:
-        parameters:
-          gitemail:
-            description: The git committer's email
-            type: string
-            default: [email protected]
-          gitusername:
-            description: The git committer's username
-            type: string
-            default: aeneasr
-          gitauthtoken:
-            description: The git committer's username
-            type: string
-        executor: changelog
-        steps:
-          - run: git config --global push.default matching
-          - checkout
-          - run: gem install github_changelog_generator -v 1.14.3
-          - run: sudo npm i -g doctoc
-          - restore_cache:
-              keys:
-                - changelog-v1
-          - run: github_changelog_generator -u $CIRCLE_PROJECT_USERNAME -p $CIRCLE_PROJECT_REPONAME -o CHANGELOG.md --token <<parameters.gitauthtoken>> --cache-file /tmp/github_changelog_generator
-          - save_cache:
-              key: changelog-v1
-              paths:
-                - "/tmp/github_changelog_generator"
-          - run: doctoc CHANGELOG.md
-          - run: git config --global user.email "<<parameters.gitemail>>"
-          - run: git config --global user.name "<<parameters.gitusername>>"
-          - run: git add CHANGELOG.md
-          - run: |
-              git commit -m "Update CHANGELOG [ci skip]" -- CHANGELOG.md
-          - run: git push origin
+  orb-tools: circleci/[email protected]
 
 workflows:
-  changelog:
+  btd:
     jobs:
-      - changelog/changelog:
-          gitauthtoken: $GITHUB_TOKEN
+      - orb-tools/publish:
+          orb-path: src/changelog.yml
+          orb-ref: ory/changelog@dev:${CIRCLE_BRANCH}
+          publish-token-variable: "$CIRCLECI_DEV_API_TOKEN"
+          validate: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,13 +1,12 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+**Table of Contents**
 
 - [Change Log](#change-log)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 # Change Log
 
+This Change Log was automatically generated
 
-
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
diff --git a/changelog.yml b/changelog.yml
diff --git a/src/changelog.yml b/src/changelog.yml
@@ -0,0 +1,60 @@
+version: 2.1
+description: Creates and updates the CHANGELOG.md file
+
+orbs:
+  changelog:
+    executors:
+      changelog:
+        docker:
+          -
+            image: circleci/ruby:2.5-node
+    jobs:
+      generate:
+        parameters:
+          gitemail:
+            description: The git committer's email
+            type: string
+            default: [email protected]
+          gitusername:
+            description: The git committer's username
+            type: string
+            default: aeneasr
+          gitauthtoken:
+            description: A GitHub API Token
+            type: env_var_name
+            default: GITHUB_TOKEN
+        executor: changelog
+        steps:
+          - run: git config --global push.default matching
+          - checkout
+          - run: gem install github_changelog_generator -v 1.14.3
+          - run: sudo npm i -g doctoc
+          - restore_cache:
+              keys:
+                - changelog-v1
+          - run: github_changelog_generator -u $CIRCLE_PROJECT_USERNAME -p $CIRCLE_PROJECT_REPONAME -o CHANGELOG.md --token ${<<parameters.gitauthtoken>>} --cache-file /tmp/github_changelog_generator
+          - save_cache:
+              key: changelog-v1
+              paths:
+                - "/tmp/github_changelog_generator"
+          - run: doctoc CHANGELOG.md
+          - run: "sed -i 's/\\*\\*Table of Contents.*/**Table of Contents**/' CHANGELOG.md"
+          - run: "sed -i 's/\\*This Change Log was.*/This Change Log was automatically generated/' CHANGELOG.md"
+          - run: git config --global user.email "<<parameters.gitemail>>"
+          - run: git config --global user.name "<<parameters.gitusername>>"
+          - run: git add CHANGELOG.md
+          - run: |
+              git commit -m "Update CHANGELOG [ci skip]" -- CHANGELOG.md || true
+          - run: git push origin || true
+
+examples:
+  changelog:
+    description: Generate and commit the changelog
+    usage:
+      version: 2.1
+      orbs:
+        foo: ory/[email protected]
+      workflows:
+        generate:
+          jobs:
+            - changelog/changelog