ci: update of files from global .github repo (#882)

.github/workflows/update-docs-on-docs-commits.yml

@@ -1,3 +1,10 @@
+# This workflow is centrally managed in https:/asyncapi/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in above mentioned repo
+
+# The given workflow is responsible for generating docs and creating PR with them when there is a commit with docs: prefix
+
+# This workflow will be updated in all repos with the topic get-global-docs-autoupdate
+
 name: 'Update generated parts of documentation on docs: commits'
 
 on:
@@ -8,32 +15,43 @@ on:
 jobs:
  docs-gen:
  name: 'Generate docs and create PR'
+ runs-on: ubuntu-latest
  # PR should be created within this GH action only if it is a docs: commit
  # Otherwise it will conflict with release workflow
  if: startsWith(github.event.commits[0].message, 'docs:')
- runs-on: ubuntu-latest
  steps:
  - name: Checkout repo
- uses: actions/checkout@v3
+ uses: actions/checkout@v4
  - name: Check package-lock version
  uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
- - name: Setup Node.js
+ id: lockversion
+ - name: Use Node.js
  uses: actions/setup-node@v3
  with:
  node-version: "${{ steps.lockversion.outputs.version }}"
+ cache: 'npm'
+ cache-dependency-path: '**/package-lock.json'
  - name: Install dependencies
  run: npm ci
  - name: Regenerate docs
  run: npm run generate:assets --if-present
  - name: Create Pull Request with updated docs
- if: startsWith(github.event.commits[0].message, 'docs:')
- uses: peter-evans/create-pull-request@38e0b6e68b4c852a5500a94740f0e535e0d7ba54 # use 4.2.4 https:/peter-evans/create-pull-request/releases/tag/v4.2.4
+ uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # uses 5.0.2 https:/peter-evans/create-pull-request/releases/tag/v5.0.2
  with:
  token: ${{ secrets.GH_TOKEN }}
  commit-message: 'chore: update generated docs'
  committer: asyncapi-bot <[email protected]>
  author: asyncapi-bot <[email protected]>
  title: 'chore: update generated docs'
  body: 'Update of docs that are generated and were forgotten on PR level.'
- branch: gen-docs-update
-
+ branch: gen-docs-update/${{ github.job }}
+ - name: Report workflow status to Slack
+ if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel
+ uses: 8398a7/action-slack@fbd6aa58ba854a740e11a35d0df80cb5d12101d8 #using https:/8398a7/action-slack/releases/tag/v3.15.1
+ with:
+ status: ${{ job.status }}
+ fields: repo,action,workflow
+ text: 'AsyncAPI docs generation workflow failed'
+ author_name: asyncapi-bot
+ env:
+ SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}