Update example and readme

onimur · Oct 1, 2020 · 27bf9ee · 27bf9ee
1 parent 9daea64
commit 27bf9ee
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -86,7 +86,6 @@ workflows:
           context: your-context           # Case contain your Github Token
           token: GITHUB_TOKEN             # Token as env_var
           git-push: true                  # Push changelog to remote repository
-          push-force: true                # Force the push to remote repository
           filters: *orb_tagged_filters    # Trigger to only tag
 ```
 
@@ -113,6 +112,15 @@ workflows:
           context: your-context           # Case contain your Github Token
           token: GITHUB_TOKEN             # Token as env_var
           git-push: false                 # The changelog will be stored in /tmp/.persist/persist/ and can be retrieved using: - attach_workspace: at: tmp //https://circleci.com/docs/2.0/configuration-reference/#example-7
+          #Push the changelog to remote repository manually
+          post-steps:
+            - run:
+                command: |
+                  git config user.name "BotUsername"
+                  git config user.email "bot@email.com"
+                  git add CHANGELOG.md
+                  git commit -m "Your description [skip ci]"
+                  git push -q https://$<<parameters.token>>@github.com/YourUser/YourProjectName.git master
           filters: *orb_tagged_filters    # Trigger to only tag
 ```
 
@@ -143,7 +151,6 @@ workflows:
           context: your-context               # Case contain your Github Token
           token: GITHUB_TOKEN                 # Token as env_var
           git-push: true                      # Push changelog to remote repository
-          push-force: true                # Force the push to remote repository
           commit-message: Update changelog    # Custom commit message
           bot-name: my-bot                    # Custom bot name
           bot-email: my-bot@email.com         # Custom bot email
@@ -183,6 +190,15 @@ workflows:
           output: CUSTOM-CHANGELOG.md
           breaking-label: "**Breaking**"
           bugs-label: "**Bugs**"
+          #Push the changelog to remote repository manually
+          post-steps:
+            - run:
+                command: |
+                  git config user.name "BotUsername"
+                  git config user.email "bot@email.com"
+                  git add CHANGELOG.md
+                  git commit -m "Your description [skip ci]"
+                  git push -q https://$<<parameters.token>>@github.com/YourUser/YourProjectName.git master
           filters: *orb_tagged_filters    # Trigger to only tag
 ```
 

diff --git a/src/examples/generate-changelog-custom-without-push.yml b/src/examples/generate-changelog-custom-without-push.yml
@@ -46,6 +46,15 @@ usage:
             output: CUSTOM-CHANGELOG.md
             breaking-label: "**Breaking**"
             bugs-label: "**Bugs**"
+            #Push the changelog to remote repository manually
+            post-steps:
+              - run:
+                  command: |
+                    git config user.name "BotUsername"
+                    git config user.email "bot@email.com"
+                    git add CHANGELOG.md
+                    git commit -m "Your description [skip ci]"
+                    git push -q https://$<<parameters.token>>@github.com/YourUser/YourProjectName.git master
             filters: *orb_tagged_filters    # Trigger to only tag
         - print-changelog:
             filters: *orb_tagged_filters

diff --git a/src/examples/generate-changelog-default-without-push.yml b/src/examples/generate-changelog-default-without-push.yml
@@ -42,6 +42,15 @@ usage:
             context: your-context           # Case contain your Github Token
             token: GITHUB_TOKEN             # Token as env_var
             push-git: false                 # The changelog will be save on /tmp/.persist/persist/
+            #Push the changelog to remote repository manually
+            post-steps:
+              - run:
+                  command: |
+                    git config user.name "BotUsername"
+                    git config user.email "bot@email.com"
+                    git add CHANGELOG.md
+                    git commit -m "Your description [skip ci]"
+                    git push -q https://$<<parameters.token>>@github.com/YourUser/YourProjectName.git master
             filters: *orb_tagged_filters    # Trigger to only tag
         - print-changelog:
             filters: *orb_tagged_filters