Skip to content

Commit

Permalink
chore: merge next-major-spec with latest master (#807)
Browse files Browse the repository at this point in the history
* feat: merge with latest master

* ci: updating spec urls to match new Information Architecture in website (#801)

* docs: fix links in Markdown files (#769)

Co-authored-by: Alejandra Quetzalli <[email protected]>
Co-authored-by: Khuda Dad Nomani <[email protected]>
  • Loading branch information
3 people authored Jun 15, 2022
1 parent 4470daa commit f269234
Show file tree
Hide file tree
Showing 22 changed files with 626 additions and 109 deletions.
67 changes: 63 additions & 4 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,9 @@
"profile": "https://waleedashraf.me/",
"contributions": [
"talk",
"ideas"
"ideas",
"doc",
"example"
]
},
{
Expand Down Expand Up @@ -215,7 +217,12 @@
"profile": "https://github.com/magicmatatjahu",
"contributions": [
"review",
"ideas"
"ideas",
"question",
"bug",
"doc",
"example",
"maintenance"
]
},
{
Expand All @@ -224,7 +231,11 @@
"avatar_url": "https://avatars.githubusercontent.com/u/193286?v=4",
"profile": "https://vladimirgorej.com/",
"contributions": [
"doc"
"doc",
"bug",
"example",
"ideas",
"review"
]
},
{
Expand Down Expand Up @@ -271,7 +282,12 @@
"contributions": [
"review",
"ideas",
"question"
"question",
"blog",
"bug",
"doc",
"example",
"maintenance"
]
},
{
Expand Down Expand Up @@ -320,6 +336,49 @@
"contributions": [
"doc"
]
},
{
"login": "luphieanza",
"name": "Muhammad Rafly Andrianza",
"avatar_url": "https://avatars.githubusercontent.com/u/20577131?v=4",
"profile": "https://github.com/luphieanza",
"contributions": [
"doc"
]
},
{
"login": "danielkocot",
"name": "Daniel Kocot",
"avatar_url": "https://avatars.githubusercontent.com/u/466609?v=4",
"profile": "https://danielkocot.github.io/",
"contributions": [
"doc",
"example",
"ideas"
]
},
{
"login": "sekharbans-ebay",
"name": "sekharbans-ebay",
"avatar_url": "https://avatars.githubusercontent.com/u/66145510?v=4",
"profile": "https://github.com/sekharbans-ebay",
"contributions": [
"doc",
"example",
"ideas"
]
},
{
"login": "damaru-inc",
"name": "Michael Davis",
"avatar_url": "https://avatars.githubusercontent.com/u/3926925?v=4",
"profile": "http://www.damaru.com/",
"contributions": [
"bug",
"doc",
"example",
"ideas"
]
}
],
"commitConvention": "none"
Expand Down
4 changes: 2 additions & 2 deletions .github/scripts/remove-toc.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module.exports = (givenSpec) => {
const startingLine = "## Table of Contents\n";
const endingLine = "<!-- /TOC -->\n";

const specFile = fs.readFileSync(`./website/pages/docs/specifications/${givenSpec}.md`);
const specFile = fs.readFileSync(`./website/pages/docs/reference/specification/${givenSpec}.md`);

const startingIndex = specFile.indexOf(startingLine);
const endingIndex = specFile.indexOf(endingLine);
Expand All @@ -21,5 +21,5 @@ module.exports = (givenSpec) => {
const firstHalf = specFile.slice(0, startingIndex);
const secondHalf = specFile.slice(endingIndex + endingLine.length);
const specWithoutToc = `${firstHalf}${secondHalf}`;
fs.writeFileSync(`./website/pages/docs/specifications/${givenSpec}.md`, specWithoutToc);
fs.writeFileSync(`./website/pages/docs/reference/specification/${givenSpec}.md`, specWithoutToc);
}
2 changes: 1 addition & 1 deletion .github/workflows/add-good-first-issue-labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const areas = ['javascript', 'typescript', 'java' , 'go', 'docs', 'ci-cd', 'design'];
const values = context.payload.comment.body.split(" ");
const values = context.payload.comment.body.trim().split(" ");
switch(values[1]){
case 'ts':
values[1] = 'typescript';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
repo: pull.head.repo.name,
basehead: `${pull.base.label}...${pull.head.label}`,
});
if (comparison.behind_by !== 0) {
if (comparison.behind_by !== 0 && pull.mergeable_state === 'behind') {
console.log(`This branch is behind the target by ${comparison.behind_by} commits`)
console.log('adding out-of-date comment...');
github.rest.issues.createComment({
Expand Down Expand Up @@ -108,4 +108,4 @@ jobs:
owner: context.repo.owner,
repo: context.repo.repo,
labels: ['autoupdate']
})
})
3 changes: 2 additions & 1 deletion .github/workflows/automerge-orphans.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:

jobs:
identify-orphans:
if: startsWith(github.repository, 'asyncapi/')
name: Find orphans and notify
runs-on: ubuntu-latest
steps:
Expand Down Expand Up @@ -57,7 +58,7 @@ jobs:
name: Send info about orphan to slack
uses: rtCamp/action-slack-notify@v2
env:
SLACK_WEBHOOK: ${{secrets.SLACK_GITHUB_NEWISSUEPR}}
SLACK_WEBHOOK: ${{secrets.SLACK_CI_FAIL_NOTIFY}}
SLACK_TITLE: 🚨 Not merged PR that should be automerged 🚨
SLACK_MESSAGE: ${{steps.issuemarkdown.outputs.text}}
MSG_MINIMAL: true
3 changes: 2 additions & 1 deletion .github/workflows/autoupdate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@ on:

jobs:
autoupdate-for-bot:
if: startsWith(github.repository, 'asyncapi/')
name: Autoupdate autoapproved PR created in the upstream
runs-on: ubuntu-latest
steps:
- name: Autoupdating
uses: docker://chinthakagodawita/autoupdate-action:v1
env:
GITHUB_TOKEN: '${{ secrets.GH_TOKEN }}'
GITHUB_TOKEN: '${{ secrets.GH_TOKEN_BOT_EVE }}'
PR_FILTER: "labelled"
PR_LABELS: "autoupdate"
PR_READY_STATE: "ready_for_review"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/help-command.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
- `/ready-to-merge` or `/rtm` - This comment will trigger automerge of PR in case all required checks are green, approvals in place and do-not-merge label is not added
- `/do-not-merge` or `/dnm` - This comment will block automerging even if all conditions are met and ready-to-merge label is added
- `/autoupdate` or `/au` - This comment will add `autoupdate` label to the PR and keeps your PR up-to-date to the target branch's future changes. Unless there is a merge conflict.
- `/autoupdate` or `/au` - This comment will add `autoupdate` label to the PR and keeps your PR up-to-date to the target branch's future changes. Unless there is a merge conflict or it is a draft PR.
create_help_comment_issue:
if: ${{ !github.event.issue.pull_request && contains(github.event.comment.body, '/help') && github.actor != 'asyncapi-bot' }}
runs-on: ubuntu-latest
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/link-check-cron.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@ on:

jobs:
External-link-validation-weekly:
if: startsWith(github.repository, 'asyncapi/')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

# Checks the status of hyperlinks in .md files
- name: Check links
uses: derberg/github-action-markdown-link-check@temporary-fix
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
Expand All @@ -32,5 +33,5 @@ jobs:
status: ${{ job.status }}
fields: repo,action,workflow
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_DOCS_CHANNEL }}
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}
if: failure() # Only, on failure, send a message on the Slack Docs Channel (if there are broken links)
2 changes: 1 addition & 1 deletion .github/workflows/link-check-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Checkout repo
uses: actions/checkout@v3
- name: Check links
uses: derberg/github-action-markdown-link-check@temporary-fix
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/new-spec-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,20 @@ jobs:
script: |
const fs = require("fs");
const specFiles = fs.readdirSync("./website/pages/docs/specifications");
const specFiles = fs.readdirSync("./website/pages/docs/reference/specification");
const nextRelease = `${{github.event.release.tag_name}}`;
const prefixRelease = nextRelease.split("-")[0];
for (const filename of specFiles) {
if (filename.startsWith(prefixRelease)) {
fs.unlinkSync(`./website/pages/docs/specifications/${filename}`);
fs.unlinkSync(`./website/pages/docs/reference/specification/${filename}`);
}
}
- name: Copy Spec file from Current Repo to Another
working-directory: ./website
run: |
cp ../spec/spec/asyncapi.md ./pages/docs/specifications/${{github.event.release.tag_name}}.md
cp ../spec/spec/asyncapi.md ./pages/docs/reference/specification/${{github.event.release.tag_name}}.md
- name: Remove Table of Contents from Spec
uses: actions/github-script@v4
with:
Expand All @@ -71,7 +71,7 @@ jobs:
const endingLine = "# LATEST-SPEC-REDIRECTION:END";
const releaseVersion = `${{github.event.release.tag_name}}`;
const redirectLine = `/docs/specifications/latest /docs/specifications/${releaseVersion} 302!\n`;
const redirectLine = `/docs/reference/specification/latest /docs/reference/specification/${releaseVersion} 302!\n`;
const redirectFile = fs.readFileSync("./website/public/_redirects", "utf-8");
Expand Down Expand Up @@ -139,7 +139,7 @@ jobs:
const releaseVersionWithoutV = releaseVersion.slice(1);
const redirectLine = `/docs/specifications/${releaseVersionWithoutV} /docs/specifications/${releaseVersion} 302!\n`;
const redirectLine = `/docs/reference/specification/${releaseVersionWithoutV} /docs/reference/specification/${releaseVersion} 302!\n`;
const redirectFile = fs.readFileSync("./website/public/_redirects", "utf-8");
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/stale-issues-prs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:

jobs:
stale:
if: startsWith(github.repository, 'asyncapi/')
name: Mark issue or PR as stale
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
- name: Copy Spec file from Current Repo to Another
working-directory: ./website
run: |
cp ../spec/spec/asyncapi.md ./pages/docs/specifications/${{ steps.latest_version.outputs.latest_tag }}.md
cp ../spec/spec/asyncapi.md ./pages/docs/reference/specification/${{ steps.latest_version.outputs.latest_tag }}.md
- name: Remove Table of Contents from Spec
uses: actions/github-script@v4
with:
Expand Down
4 changes: 3 additions & 1 deletion .releaserc
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
branches:
- master
- name: 2022-04-release
- name: next-spec
prerelease: true
- name: next-major-spec
prerelease: true
plugins:
- - "@semantic-release/commit-analyzer"
Expand Down
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
Loading

0 comments on commit f269234

Please sign in to comment.