-
-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into code_of_conduct
- Loading branch information
Showing
11 changed files
with
215 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
### Definition of a Working Group | ||
|
||
A Working Group is a group of people in our community who share a common interest beyond GitHub repositories. | ||
|
||
A Working Group must have at least one of its members appointed as its chairperson. | ||
|
||
Anyone can create a Working Group. The only prerequisites are to have at least 3 founding members and the approval of the TSC (Technical Steering Committee). | ||
|
||
A Working Group should have clearly defined goals that are easily accessible to everyone on the internet, as this helps maintain alignment within the group. | ||
|
||
It is recommended that the Working Group has an associated project management tool like [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project) (or any other project management tool) to outline their roadmap. It's up to the Working Group to decide the structure of the project. E.g., Kanban, Shape Up, TO-DO list, etc. | ||
|
||
The group's name, members, goals, and other relevant information must be added to the `WORKING_GROUPS.yaml` file in the `community` repository. | ||
|
||
A Working Group has no authority or power over the roadmap of the projects they may impact. It's up to the repositories' maintainers (code owners) to approve or reject the pull requests. Therefore, it's advisable to either have maintainers of the impacted projects in the Working Group or ensure everyone agrees on the roadmap of the different repositories/projects. | ||
|
||
Working Groups should be listed on the [AsyncAPI website](https://www.asyncapi.com), along with their description, goals, members, and anything the Working Group wants to include. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# This file contains the list of the currently active working groups. | ||
# | ||
# To learn more about working groups, read the WORKING_GROUPS.md file. | ||
|
||
working_groups: | ||
# - name: Required. The name of the working group. | ||
# description: Required. Describe what this working group is about. | ||
# chairperson: Required. GitHub handle of the chairperson. Example: @Barbanio. | ||
# members: # Required to have at least 2 members who are not the same as the chairperson. | ||
# - @fmvilas # GitHub handle of the member. | ||
# slack_channel: # Required. The name of the Slack channel in the AsyncAPI workspace. Example: community_growth_wg | ||
# okrs_url: https://example.com/xyz # Required. Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives. | ||
# roadmap_url: https://example.com/xyz # Recommended. Link to a GitHub project, issue, or any other tool where the Working Group outlines their roadmap. | ||
# github_team: # Recommended. The GitHub team handle to tag all the working group members at once. Example: @asyncapi/community_growth_wg. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Do you have some nice ideas for #AsyncAPI-related tools? Do you want to validate and share with the AsyncAPI community? | ||
|
||
Drop it 👇 and let us have an open discussion 🚀 | ||
|
||
https://github.com/asyncapi/community/discussions/categories/ideas |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
✨ Did you know #AsyncAPI is on Slack? ✨ | ||
|
||
Join our Slack workspace to chat with anyone from our Open-Source community! | ||
|
||
🔗 asyncapi.com/slack-invite | ||
|
||
Ask for help and help others too. 💪🏿💪🏽🦾 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
✨ Did you know #AsyncAPI is on Slack? ✨ | ||
|
||
Join our Slack workspace to chat with anyone from our Open-Source community! | ||
|
||
🔗 asyncapi.com/slack-invite | ||
|
||
Ask for help and help others too. 💪🏿💪🏽🦾 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
✨ Did you know #AsyncAPI is on Slack? ✨ | ||
|
||
Join our Slack workspace to chat with anyone from our Open-Source community! | ||
|
||
🔗 asyncapi.com/slack-invite | ||
|
||
Ask for help and help others too. 💪🏿💪🏽🦾 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
✨ Did you know #AsyncAPI is on Slack? ✨ | ||
|
||
Join our Slack workspace to chat with anyone from our Open-Source community! | ||
|
||
🔗 asyncapi.com/slack-invite | ||
|
||
Ask for help and help others too. 💪🏿💪🏽🦾 |