chore(docs): deploy docs gh pages github workflow (#4)

* chore(docs): deploy docs in gh pages

we added some steps in github workflow to deploy the documentation in github pages

* chore(docs): remove mkdocs configuration of emojis

this extension is no longer exists

* chore(docs): add alias and version number to the docs deploy

we add the git user and mail

* chore(docs): fix the run command in set upd docs deploy step

We added a doble quites unexpected, we remove it here

* chore(docs): remove doble quotes when we adde the git user configuration

there was an unexpectd doble quotes

* chore(docs): add github deploy command for docs

this command deploy the documentacion in Github Pages

* chore(docs): deploy docs with mike command

with this type of deployment, we will have all versions available in the doc

* WIP: add console log of release tag

we need the version number

* chore(docs): add step to get the last tag

we need this tag for mkdocs deployment

* chore(docs): add output with latest version tags

we use this output in the step to deploy de version of the docs

* chore(docs): add a git command to get the lates tag

we use this to create a new release of the doc

* chore(docs): change the code to get the tag version

we need this version to deploy docs

* chore(docs): add full clone

we need this version to deploy docs

* feat(docs): add mkdocs deploy

it add in gihub workflow the step to deploy in github pages

* feat(docs): update api docs

it updates the construct hub badge

Author: antonio-marquez-perez

.github/workflows/deploy-docs.yml

@@ -61,21 +61,45 @@ deployDocs?.on({
     workflows: ['release'],
     types: ['completed'],
   },
+  workflowCall: {
+    inputs: {
+      version: {
+        required: true,
+        type: 'string',
+        description: 'Version to build and publish docs',
+      },
+      alias: {
+        required: true,
+        type: 'string',
+        description: 'Alias to associate version (latest, stage)',
+      },
+    },
+  },
 });
 
 deployDocs?.addJob('deploy-docs', {
   permissions: {
     contents: JobPermission.WRITE,
+    pages: JobPermission.WRITE,
   },
   runsOn: ['ubuntu-latest'],
+  outputs: {
+    getVersion: {
+      stepId: 'getVersion',
+      outputName: 'version',
+    },
+  },
   steps: [
     {
       uses: 'actions/checkout@v4',
+      with: {
+        'fetch-depth': 0,
+      },
     },
     {
       uses: 'actions/setup-python@v4',
       with: {
-        pythonVersion: '3.x',
+        pythonVersion: '3.8',
       },
     },
     {
@@ -89,10 +113,38 @@ deployDocs?.addJob('deploy-docs', {
       },
     },
     {
-      run: 'pip install mkdocs-material',
+      name: 'Install doc generations dependencies',
+      run: [
+        'pip install --upgrade pip',
+        'pip install -r docs/requirements.txt',
+      ].join('\n'),
+    },
+    {
+      name: 'Setup docs deploy',
+      run: [
+        'git config user.name github-actions',
+        'git config user.email [email protected]',
+      ].join('\n'),
     },
     {
-      run: 'mkdocs gh-deploy --force',
+      name: 'Get the version',
+      id: 'getVersion',
+      run: [
+        'echo "version=$(git describe --tags --abbrev=0)"',
+        'echo "version=$(git describe --tags --abbrev=0)" >> "$GITHUB_OUTPUT"',
+      ].join('\n'),
+    },
+    {
+      name: 'Build and deploy documentation',
+      env: {
+        ALIAS: 'latest',
+        VERSION: '${{ needs.deploy-docs.outputs.version }}',
+      },
+      run: [
+        'echo ${{ env.VERSION }}',
+        'mkdocs build',
+        'mkdocs gh-deploy --force',
+      ].join('\n'),
     },
   ],
 });

.projenrc.ts

@@ -1,6 +1,7 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 ![npm](https://img.shields.io/npm/v/%40jttc%2Faws-codestarconnection)
 
+[![View on Construct Hub](https://constructs.dev/badge?package=%40jttc%2Faws-codestarconnection)](https://constructs.dev/packages/@jttc/aws-codestarconnection)
 # AWS CodeStar Connection Construct Library
 
 This package contains constructs for working with Amazon CodeStar Connection.

API.md

@@ -0,0 +1,4 @@
+mike==1.1.2
+mkdocs-material==9.3.2
+mkdocs-git-revision-date-plugin==0.3.2
+mkdocs-exclude==1.0.2

README.md

@@ -55,6 +55,3 @@ markdown_extensions:
   - pymdownx.snippets
   - attr_list
   - tables
-  - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg