GitHub action Writerside version 1

Author: lananovikova10

Dockerfile

@@ -0,0 +1,8 @@
+# Container image that runs your code
+FROM registry.jetbrains.team/p/writerside/builder/writerside-builder:2.1.984
+
+# Copies your code file from your action repository to the filesystem path `/` of the container
+COPY entrypoint.sh /entrypoint.sh
+
+# Code file to execute when the docker container starts up (`entrypoint.sh`)
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -0,0 +1,108 @@
+# A GitHub action for building a Writerside docs artifacts in a Docker container
+
+This action creates a zip-archive with HTMLs from markdown or semantic markup topics.
+
+## Environment variables
+
+### `ARTIFACT`
+
+The name of the archive is webHelpXX2-all.zip where XX gets replaced by the instance id in caps.
+
+### `PRODUCT`
+
+The $PRODUCT should be name_of_module / instance_id, for example sample_module/sd. No default value.
+
+## Example usage with the build HTMLs only
+
+```yml
+name: Build docs
+
+on:
+push:
+branches: ["main"]
+
+workflow_dispatch:
+
+env:
+PRODUCT: module/instance-id
+ARTIFACT: webHelpXX2-all.zip
+
+jobs:
+build-job:
+runs-on: ubuntu-latest
+steps:
+- name: Checkout repository
+uses: actions/checkout@v3
+- name: Build Writerside docs with docker
+uses: JetBrains/writerside-github-action@v1
+- name: Upload artifact
+uses: actions/upload-artifact@v3
+with:
+name: artifact
+path: artifacts/${{ env.ARTIFACT }}
+retention-days: 7
+```
+
+
+## Example usage with build and publish to GitHub pages
+
+```yml
+name: Build docs
+
+on:
+push:
+branches: ["main"]
+
+workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+contents: read
+pages: write
+id-token: write
+
+env:
+    PRODUCT: module/instance-id
+    ARTIFACT: webHelpXX2-all.zip
+
+jobs:
+    build-job:
+    runs-on: ubuntu-latest
+    steps:
+        - name: Checkout repository
+          uses: actions/checkout@v3
+        - name: Build Writerside docs with docker
+          uses: JetBrains/writerside-github-action@v1
+        - name: Upload artifact
+          uses: actions/upload-artifact@v3
+          with:
+            name: artifact
+            path: artifacts/${{ env.ARTIFACT }}
+            retention-days: 7
+
+deploy:
+    environment:
+    name: github-pages
+    url: ${{ steps.deployment.outputs.page_url }}
+    needs: build-job
+    runs-on: ubuntu-latest
+    steps:
+    - name: Download artifact
+      uses: actions/download-artifact@v3
+      with:
+        name: artifact
+    - name: Unzip artifact
+      uses: montudor/action-zip@v1
+      with:
+        args: unzip -qq ${{ env.ARTIFACT }} -d dir
+    - name: Setup Pages
+      uses: actions/configure-pages@v2
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: dir
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v1
+
+```

action.yml

@@ -0,0 +1,10 @@
+name: Build Writerside docs with Docker
+description: Build Writerside documentation artifacts
+author: writerside <writerside@jetbrains.com>
+branding:
+    icon: book-open
+    color: purple
+
+runs:
+    using: 'docker'
+    image: 'Dockerfile'

entrypoint.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+/opt/builder/bin/idea.sh helpbuilderinspect -source-dir . -product $PRODUCT -output-dir artifacts/ || true
+echo "Test existing of $ARTIFACT artifact"
+test -e artifacts/$ARTIFACT