-
-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: release of long living release candidate (#764)
Co-authored-by: asyncapi-bot <[email protected]>%0ACo-authored-by: Samriddhi <[email protected]>%0ACo-authored-by: W0nderMuffin <[email protected]>%0ACo-authored-by: Viacheslav Turovskyi <[email protected]>%0ACo-authored-by: Andrea Falzetti <[email protected]>%0ACo-authored-by: asyncapi-bot <[email protected]>%0ACo-authored-by: Dale Lane <[email protected]>%0ACo-authored-by: Dominik Schwank <[email protected]>%0ACo-authored-by: Kai Szybiak <[email protected]>%0ACo-authored-by: Ludovic Dussart <[email protected]>%0ACo-authored-by: Marcelo Avancini <[email protected]>%0ACo-authored-by: thim81 <[email protected]>%0ACo-authored-by: Maciej Urbańczyk <[email protected]>
- Loading branch information
1 parent
01ce374
commit 6409130
Showing
183 changed files
with
103,870 additions
and
57,337 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
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
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 |
---|---|---|
|
@@ -12,16 +12,21 @@ jobs: | |
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
uses: actions/checkout@v3 | ||
with: | ||
# target branch of release. More info https://docs.github.com/en/rest/reference/repos#releases | ||
# in case release is created from release branch then we need to checkout from given branch | ||
# if @semantic-release/github is used to publish, the minimum version is 7.2.0 for proper working | ||
ref: ${{ github.event.release.target_commitish }} | ||
- name: Check package-lock version | ||
uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master | ||
id: lockversion | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v1 | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 14 | ||
node-version: "${{ steps.lockversion.outputs.version }}" | ||
cache: 'npm' | ||
cache-dependency-path: '**/package-lock.json' | ||
- name: Install latest version of library in the web-component | ||
run: VERSION=${{github.event.release.tag_name}} npm run install:reactcomp | ||
working-directory: ./web-component | ||
|
@@ -33,37 +38,41 @@ jobs: | |
# When adding "bump:version" script in package.json, make sure --allow-same-version is set in case someone forgot and updated package.json manually and we want to avoide this action to fail and raise confusion | ||
run: VERSION=${{github.event.release.tag_name}} npm run bump:webcomp:version | ||
- name: Release web-component to NPM (@latest tag) | ||
if: github.event.release.target_commitish != 'next' | ||
uses: JS-DevTools/npm-publish@v1 | ||
if: github.event.release.target_commitish == 'master' | ||
uses: JS-DevTools/npm-publish@5a85faf05d2ade2d5b6682bfe5359915d5159c6c # using 2.2.1 version https://github.com/JS-DevTools/npm-publish/releases/tag/v2.2.1 | ||
with: | ||
token: ${{ secrets.NPM_TOKEN }} | ||
package: ./web-component/package.json | ||
access: public | ||
- name: Release web-component to NPM (@next tag) | ||
if: github.event.release.target_commitish == 'next' | ||
uses: JS-DevTools/npm-publish@v1 | ||
- name: Release web-component to NPM (feature branch tag) | ||
if: github.event.release.target_commitish != 'master' | ||
uses: JS-DevTools/npm-publish@5a85faf05d2ade2d5b6682bfe5359915d5159c6c # using 2.2.1 version https://github.com/JS-DevTools/npm-publish/releases/tag/v2.2.1 | ||
with: | ||
token: ${{ secrets.NPM_TOKEN }} | ||
package: ./web-component/package.json | ||
access: public | ||
tag: next | ||
tag: github.event.release.target_commitish | ||
|
||
playground: | ||
name: Release Playground | ||
if: github.event.release.target_commitish == 'next' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
uses: actions/checkout@v3 | ||
with: | ||
# target branch of release. More info https://docs.github.com/en/rest/reference/repos#releases | ||
# in case release is created from release branch then we need to checkout from given branch | ||
# if @semantic-release/github is used to publish, the minimum version is 7.2.0 for proper working | ||
ref: ${{ github.event.release.target_commitish }} | ||
- name: Check package-lock version | ||
uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master | ||
id: lockversion | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v1 | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 14 | ||
node-version: "${{ steps.lockversion.outputs.version }}" | ||
cache: 'npm' | ||
cache-dependency-path: '**/package-lock.json' | ||
- name: Use latest version of react component in the playground | ||
run: VERSION=${{github.event.release.tag_name}} npm run install:reactcomp | ||
working-directory: ./playground | ||
|
@@ -73,10 +82,10 @@ jobs: | |
run: npm run build | ||
working-directory: ./playground | ||
- name: Deploy GH page | ||
uses: JamesIves/github-pages-deploy-action@3.4.2 | ||
uses: JamesIves/github-pages-deploy-action@a1ea191d508feb8485aceba848389d49f80ca2dc # use v4.4.3 https://github.com/JamesIves/github-pages-deploy-action/releases/tag/v4.4.3 | ||
with: | ||
ACCESS_TOKEN: ${{ secrets.GH_TOKEN }} | ||
BRANCH: gh-pages | ||
FOLDER: playground/build | ||
GIT_CONFIG_NAME: asyncapi-bot | ||
GIT_CONFIG_EMAIL: [email protected] | ||
token: ${{ secrets.GH_TOKEN }} | ||
branch: gh-pages | ||
folder: playground/build | ||
git-config-name: asyncapi-bot | ||
git-config-email: [email protected] |
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 |
---|---|---|
|
@@ -82,4 +82,4 @@ jobs: | |
body: message, | ||
event: 'COMMENT' | ||
}); | ||
} | ||
} |
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,9 @@ | ||
# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/ | ||
tasks: | ||
- init: npm install # runs during prebuild | ||
command: npm start | ||
|
||
# List the ports to expose. Learn more https://www.gitpod.io/docs/config-ports/ | ||
ports: | ||
- port: 3000 | ||
onOpen: open-preview |
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 @@ | ||
sonar.exclusions=library/src/components/Schema.tsx,library/src/helpers/schema.ts,library/src/containers/Error/Error.tsx,library/e2e/**/* |
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 |
---|---|---|
@@ -1,79 +1,36 @@ | ||
# Contributing to AsyncAPI | ||
We love your input! We want to make contributing to this project as easy and transparent as possible. | ||
# Contributing | ||
|
||
## Contribution recogniton | ||
## Overview | ||
|
||
We use [All Contributors](https://allcontributors.org/docs/en/specification) specification to handle recognitions. For more details read [this](https://github.com/asyncapi/community/blob/master/recognize-contributors.md) document. | ||
Learn the rules to follow when you contribute code or content to this project. | ||
|
||
## Summary of the contribution flow | ||
## Contributing process | ||
|
||
The following is a summary of the ideal contribution flow. Please, note that Pull Requests can also be rejected by the maintainers when appropriate. | ||
The contributing process in this project relies on the [GitHub flow](https://guides.github.com/introduction/flow/index.html). This means that you contribute through pull requests (PRs). When adding new code or content to this project, follow these rules: | ||
|
||
``` | ||
┌───────────────────────┐ | ||
│ │ | ||
│ Open an issue │ | ||
│ (a bug report or a │ | ||
│ feature request) │ | ||
│ │ | ||
└───────────────────────┘ | ||
⇩ | ||
┌───────────────────────┐ | ||
│ │ | ||
│ Open a Pull Request │ | ||
│ (only after issue │ | ||
│ is approved) │ | ||
│ │ | ||
└───────────────────────┘ | ||
⇩ | ||
┌───────────────────────┐ | ||
│ │ | ||
│ Your changes will │ | ||
│ be merged and │ | ||
│ published on the next │ | ||
│ release │ | ||
│ │ | ||
└───────────────────────┘ | ||
``` | ||
1. Fork this repository. | ||
1. Make your changes. Do not forgot about: | ||
- [Naming and architecture convention](./DEVELOPMENT.md#naming--architecture-convention) | ||
- [Project structure](./development-guide.md/#project-structure) | ||
- Tests | ||
- Updating relevant documents if you add, remove, update props or configuration. | ||
1. Create a PR. | ||
|
||
## Code of Conduct | ||
AsyncAPI has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](./CODE_OF_CONDUCT.md) so that you can understand what sort of behaviour is expected. | ||
|
||
## Our Development Process | ||
We use Github to host code, to track issues and feature requests, as well as accept pull requests. | ||
|
||
## Issues | ||
[Open an issue](https://github.com/asyncapi/asyncapi/issues/new) **only** if you want to report a bug or a feature. Don't open issues for questions or support, instead join our [Slack workspace](https://www.asyncapi.com/slack-invite) and ask there. Don't forget to follow our [Slack Etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) while interacting with community members! It's more likely you'll get help, and much faster! | ||
|
||
## Bug Reports and Feature Requests | ||
|
||
Please use our issues templates that provide you with hints on what information we need from you to help you out. | ||
|
||
## Pull Requests | ||
|
||
**Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or a really obvious error.** Pull requests are the best way to propose changes to the specification. Get familiar with our document that explains [Git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md) used in our repositories. | ||
PRs are very welcome. However, if you want to add a new feature, use GitHub issues to discuss your ideas first. | ||
|
||
## Conventional commits | ||
|
||
Our repositories follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/). | ||
|
||
Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification simply ask maintainers to modify. You can also use this cheatsheet if you want: | ||
|
||
- `fix: ` prefix in the title indicates that PR is a bug fix and PATCH release must be triggered. | ||
- `feat: ` prefix in the title indicates that PR is a feature and MINOR release must be triggered. | ||
- `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release. | ||
- `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release. | ||
- `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release. | ||
- `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release. | ||
|
||
What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: ` | ||
This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/). | ||
|
||
Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative). | ||
A PR should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification, simply ask maintainers to modify the PR. You can also use this cheatsheet: | ||
|
||
Happy contributing :heart: | ||
- `fix: ` prefix in the title indicates that a PR is a bug fix and the PATCH release must be triggered. | ||
- `feat: ` prefix in the title indicates that a PR is a feature and the MINOR release must be triggered. | ||
- `docs: ` prefix in the title indicates that a PR is only related to the documentation and there is no need to trigger a release. | ||
- `chore: ` prefix in the title indicates that a PR is only related to the project cleanup and there is no need to trigger a release. | ||
- `test: ` prefix in the title indicates that a PR is only related to tests and there is no need to trigger a release. | ||
- `refactor: ` prefix in the title indicates that a PR is only related to refactoring and there is no need to trigger a release. | ||
|
||
## License | ||
When you submit changes, your submissions are understood to be under the same [Apache 2.0 License](https://github.com/asyncapi/asyncapi/blob/master/LICENSE) that covers the project. Feel free to [contact the maintainers](https://www.asyncapi.com/slack-invite) if that's a concern. | ||
For a MAJOR release, just add `!` to the prefix, like `fix!: ` or `refactor!: `. | ||
|
||
## References | ||
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md). | ||
A prefix that follows the specification is not enough though. Remember that the title must be clear, descriptive, and in the [imperative mood](https://chris.beams.io/posts/git-commit/#imperative). |
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
Oops, something went wrong.