Merge pull request #11 from DealerDotCom/feature/changelog

Create changelog-enforcer.yml

Author: DanMat

.github/build.sh

@@ -23,3 +23,7 @@ bundle exec middleman build --clean
 ## To the internal doc build folder
 cd $GITHUB_WORKSPACE
 mv /usr/src/app/build $INTERNAL_DOC_BUILD
+
+## Zipping the build to tag them as released in github
+echo "Zipping the generated docs"
+zip -r $ZIP_DOC_BUILD $EXTERNAL_DOC_BUILD $INTERNAL_DOC_BUILD

.github/workflows/build-deploy.yml

@@ -10,6 +10,7 @@ jobs:
     env:
       external-doc-build: external_build
       internal-doc-build: internal_build
+      zip-doc-build: documents.zip
 
     steps:
     - name: Accessing github project files
@@ -22,6 +23,60 @@ jobs:
       env:
         EXTERNAL_DOC_BUILD: ${{ env.external-doc-build }}
         INTERNAL_DOC_BUILD: ${{ env.internal-doc-build }}
+        ZIP_DOC_BUILD: ${{ env.zip-doc-build }}
+
+    - name: Get changes from CHANGELOG.md
+      id: changelog_reader
+      uses: mindsers/changelog-reader-action@v2
+      with:
+          version: Unreleased
+
+    - name: Generate release timestamp
+      id: tag
+      run: echo "::set-output name=date::$(date +'%Y-%m-%dT%H.%M.%S')"
+
+    - name: Push a release tag
+      id: push_tag
+      uses: mathieudutour/[email protected]
+      with:
+        github_token: ${{ secrets.GH_TOKEN }}
+        custom_tag: ${{ steps.tag.outputs.date }}
+
+    - name: Create Release
+      id: create_release
+      uses: actions/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      with:
+        tag_name: v${{ steps.tag.outputs.date }}
+        release_name:  ${{ steps.tag.outputs.date }}
+        body: ${{ steps.changelog_reader.outputs.changes }}
+        prerelease: false
+        draft: false
+
+    - name: Upload Release Asset
+      uses: actions/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: ./${{ env.zip-doc-build }}
+        asset_name: ${{ env.zip-doc-build }}
+        asset_content_type: application/zip
+
+    - name: Update changelog
+      uses: thomaseizinger/keep-a-changelog-new-release@v1
+      with:
+        version: v${{ steps.tag.outputs.date }}
+
+    - name: Commit changelog
+      run: |
+        git config user.name "GitHub actions"
+        git config user.email [email protected]
+        git add CHANGELOG.md
+        git commit --message "Updating Changelog"
+        echo "::set-output name=commit::$(git rev-parse HEAD)"
+        git push
 
     - name: Deploy external documentation
       uses: peaceiris/[email protected]

.github/workflows/changelog-enforcer.yml

@@ -0,0 +1,17 @@
+name: Changelog Enforcer
+on:
+  pull_request:
+      types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
+
+jobs:
+  # Enforces the update of a changelog file on every pull request 
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Accessing github project files
+      uses: actions/checkout@v2
+      
+    - uses: dangoslen/changelog-enforcer@v2
+      with:
+        changeLogPath: 'CHANGELOG.md'
+        skipLabels: 'Skip-Changelog'

CHANGELOG.md

@@ -1,18 +1,11 @@
 # Changelog
+All notable changes to this project will be documented in this file.
+
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Documentation Update <sub><sup>(February 16, 2021)</sup></sub>
-### Changed
-* Added documentation for two <a href="https://dealerdotcom.github.io/web-integration-api-docs/#insert-locations">Insert Locations</a>.
-* <a href="https://dealerdotcom.github.io/web-integration-api-docs/#content">`content`</a> requires that a landing page be created with this target.
-* <a href="https://dealerdotcom.github.io/web-integration-api-docs/#secondary-content">`secondary-content`</a> is present ~2/3 of the way down on details pages.
-
-## Documentation Update <sub><sup>(February 5, 2021)</sup></sub>
-### Changed
-* Updated code examples to use modern practices.
-* `var` has been replaced with `const` or `let`, and all functions have been replaced by arrow functions.
-
-## 1.2.33 <sub><sup>(January 27, 2021)</sup></sub>
+## [Unreleased]
 ### Added
-* Added `digital-retailing` location for placement of Digital Retailing integration content, such as an iframe.
+* Added a changelog enforcer to the workflow.
+* Tagging and uploading the releases.
+* Updating the changelog after a release

Dockerfile

@@ -6,7 +6,7 @@ COPY .github/build.sh /usr/src/bin/
 
 RUN gem install bundler
 
-RUN apk --no-cache --update add nodejs g++ make coreutils git && \
+RUN apk --no-cache --update add nodejs g++ make coreutils git zip && \
     git clone https://github.com/slatedocs/slate.git /usr/src/app && \
     bundle install && \
     chmod +x /usr/src/bin/*.sh