Skip to content

Commit

Permalink
Merge branch 'master' into seo-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
CBID2 authored Feb 16, 2024
2 parents 02c1621 + c7a83f8 commit b038d16
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 3 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/update-docs-on-docs-commits.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# This workflow is centrally managed in https://github.com/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:
push:
branches:
- master

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:')
steps:
- name: Checkout repo
uses: actions/checkout@v4
- name: Check package-lock version
uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
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
uses: peter-evans/create-pull-request@153407881ec5c347639a548ade7d8ad1d6740e38 # uses 5.0.2 https://github.com/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/${{ 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://github.com/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 }}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Improve the [AsyncAPI website](https://github.com/asyncapi/website)'s robustness
- 🛠️ **Skills:** JavaScript, Next.js, unit testing, and CI/CD practices.
- 🧩 **Difficulty:** Medium/Hard
- 👩🏿‍🏫 **Mentor(s):** [@akshatnema](https://github.com/akshatnema), [@anshgoyalevil](https://github.com/anshgoyalevil)
-**Length:** 320 Hours
-**Length:** 350 Hours

## 3) [Integration Testing Library for Code Generators](https://github.com/asyncapi/generator/issues/752)
Enhance the [Generator tool](https://github.com/asyncapi/generator) by introducing a feature or creating a new library to simplify integration testing for code generation templates. This solution facilitates the activation of integration tests, ensuring reliability and robustness with our code generators.
Expand All @@ -44,7 +44,7 @@ Create a UI Kit for the AsyncAPI website to ensure brand visual consistency and
- 🛠️ **Skills:** JavaScript, React, Storybook, and TailwindCSS.
- 🧩 **Difficulty:** Easy/Medium
- 👩🏿‍🏫 **Mentor(s):** [@acethecreator](https://github.com/acethecreator), [@akshatnema](https://github.com/akshatnema)
-**Length:** 320 Hours
-**Length:** 350 Hours

## 6) [Dynamic Open Graph Preview for AsyncAPI Studio](https://github.com/asyncapi/studio/issues/224)
Improve social sharing for [AsyncAPI Studio](https://studio.asyncapi.com/) by implementing a dynamic Open Graph link preview generator. This feature will create context-specific preview images for shared links, incorporating key details like the title, description, and statistics from the shared AsyncAPI document.
Expand All @@ -66,7 +66,7 @@ Upgrade [AsyncAPI Studio](https://studio.asyncapi.com/) to support real-time col

## Contact AsyncAPI Mentors
- Join [our Slack workspace](https://www.asyncapi.com/slack-invite). Observe our [Slack etiquette](https://github.com/asyncapi/.github/blob/master/slack-etiquette.md) and [AsyncAPI code of conduct](https://github.com/asyncapi/.github/blob/master/CODE_OF_CONDUCT.md).
- Join the dedicated Mentorship channel `#mentorships` to meet all other GSoC mentees and mentors.
- Join the dedicated Mentorship channel `#09_mentorships` to meet all other GSoC mentees and mentors.

## FAQ
1. **How active are previous GSoC contributors in AsyncAPI?**
Expand Down

0 comments on commit b038d16

Please sign in to comment.