Skip to content

Commit

Permalink
Merge branch 'master' into refactor/fetch-asyncapi-example
Browse files Browse the repository at this point in the history
  • Loading branch information
@asyncapi-bot
asyncapi-bot authored May 13, 2024
2 parents 000176a + 5c99587 commit 6e37a36
Show file tree
Hide file tree
Showing 13 changed files with 202 additions and 157 deletions.
50 changes: 43 additions & 7 deletions .github/workflows/bounty-program-commands.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,18 @@ on:
types:
- created

env:
BOUNTY_PROGRAM_LABELS_JSON: |
[
{"name": "bounty", "color": "0e8a16", "description": "Participation in the Bounty Program"}
]
jobs:
guard-against-unauthorized-use:
if: >
github.actor != ('aeworxet' || 'thulieblack') &&
(
contains(github.event.comment.body, '/bounty' )
startsWith(github.event.comment.body, '/bounty' )
)
runs-on: ubuntu-latest
Expand All @@ -46,15 +52,10 @@ jobs:
if: >
github.actor == ('aeworxet' || 'thulieblack') &&
(
contains(github.event.comment.body, '/bounty' )
startsWith(github.event.comment.body, '/bounty' )
)
runs-on: ubuntu-latest
env:
BOUNTY_PROGRAM_LABELS_JSON: |
[
{"name": "bounty", "color": "0e8a16", "description": "Participation in the Bounty Program"}
]

steps:
- name: Add label `bounty`
Expand Down Expand Up @@ -88,3 +89,38 @@ jobs:
repo: context.repo.repo,
labels: [BOUNTY_PROGRAM_LABELS[0].name]
})
remove-label-bounty:
if: >
github.actor == ('aeworxet' || 'thulieblack') &&
(
startsWith(github.event.comment.body, '/unbounty' )
)
runs-on: ubuntu-latest

steps:
- name: Remove label `bounty`
uses: actions/github-script@v6

with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const BOUNTY_PROGRAM_LABELS = JSON.parse(process.env.BOUNTY_PROGRAM_LABELS_JSON);
let LIST_OF_LABELS_FOR_ISSUE = await github.rest.issues.listLabelsOnIssue({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
});
LIST_OF_LABELS_FOR_ISSUE = LIST_OF_LABELS_FOR_ISSUE.data.map(key => key.name);
if (LIST_OF_LABELS_FOR_ISSUE.includes(BOUNTY_PROGRAM_LABELS[0].name)) {
console.log('Removing label `bounty`...');
github.rest.issues.removeLabel({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
name: [BOUNTY_PROGRAM_LABELS[0].name]
})
}
82 changes: 45 additions & 37 deletions docs/usage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli
$ asyncapi COMMAND
running command...
$ asyncapi (--version)
@asyncapi/cli/1.11.0 linux-x64 node-v18.20.2
@asyncapi/cli/1.12.2 linux-x64 node-v18.20.2
$ asyncapi --help [COMMAND]
USAGE
$ asyncapi COMMAND
Expand Down Expand Up @@ -65,33 +65,38 @@ USAGE

## `asyncapi bundle`

bundle one or multiple asyncapi documents and their references together.
Bundle one or multiple AsyncAPI Documents and their references together.

```
USAGE
$ asyncapi bundle [-h] [-o <value>] [-r] [-b <value>]
$ asyncapi bundle [-h] [-o <value>] [-b <value>] [-d <value>] [-x]
FLAGS
-b, --base=<value> Path to the file which will act as a base. This is required when some properties are
to needed to be overwritten.
-h, --help Show CLI help.
-o, --output=<value> The output file name. Omitting this flag the result will be printed in the console.
-r, --reference-into-components Bundle the message $refs into components object.
-b, --base=<value> Path to the file which will act as a base. This is required when some properties need to be
overwritten.
-d, --baseDir=<value> One relative/absolute path to directory relative to which paths to AsyncAPI Documents that
should be bundled will be resolved.
-h, --help Show CLI help.
-o, --output=<value> The output file name. Omitting this flag the result will be printed in the console.
-x, --xOrigin Pass this switch to generate properties "x-origin" that will contain historical values of
dereferenced "$ref"s.
DESCRIPTION
bundle one or multiple asyncapi documents and their references together.
Bundle one or multiple AsyncAPI Documents and their references together.
EXAMPLES
$ asyncapi bundle ./asyncapi.yaml > final-asyncapi.yaml
$ asyncapi bundle ./asyncapi.yaml --output final-asyncapi.yaml
$ asyncapi bundle ./asyncapi.yaml ./features.yaml --reference-into-components
$ asyncapi bundle ./asyncapi.yaml ./features.yaml
$ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml
$ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./main.yaml --xOrigin
$ asyncapi bundle ./asyncapi.yaml ./features.yaml --base ./asyncapi.yaml --reference-into-components
$ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service
```

_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/bundle.ts)_
_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/bundle.ts)_

## `asyncapi config`

Expand All @@ -105,7 +110,7 @@ DESCRIPTION
CLI config settings
```

_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/index.ts)_
_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/index.ts)_

## `asyncapi config analytics`

Expand All @@ -125,7 +130,7 @@ DESCRIPTION
Enable or disable analytics for metrics collection
```

_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/analytics.ts)_
_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/analytics.ts)_

## `asyncapi config context`

Expand All @@ -139,7 +144,7 @@ DESCRIPTION
Manage short aliases for full paths to AsyncAPI documents
```

_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/index.ts)_
_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/index.ts)_

## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH`

Expand All @@ -161,7 +166,7 @@ DESCRIPTION
Add a context to the store
```

_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/add.ts)_
_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/add.ts)_

## `asyncapi config context current`

Expand All @@ -178,7 +183,7 @@ DESCRIPTION
Shows the current context that is being used
```

_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/current.ts)_
_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/current.ts)_

## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH`

Expand All @@ -199,7 +204,7 @@ DESCRIPTION
Edit a context in the store
```

_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/edit.ts)_
_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/edit.ts)_

## `asyncapi config context init [CONTEXT-FILE-PATH]`

Expand All @@ -222,7 +227,7 @@ DESCRIPTION
Initialize context
```

_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/init.ts)_
_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/init.ts)_

## `asyncapi config context list`

Expand All @@ -239,7 +244,7 @@ DESCRIPTION
List all the stored contexts in the store
```

_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/list.ts)_
_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/list.ts)_

## `asyncapi config context remove CONTEXT-NAME`

Expand All @@ -259,7 +264,7 @@ DESCRIPTION
Delete a context from the store
```

_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/remove.ts)_
_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/remove.ts)_

## `asyncapi config context use CONTEXT-NAME`

Expand All @@ -279,7 +284,7 @@ DESCRIPTION
Set a context as current
```

_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/context/use.ts)_
_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/context/use.ts)_

## `asyncapi config versions`

Expand All @@ -296,7 +301,7 @@ DESCRIPTION
Show versions of AsyncAPI tools used
```

_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/config/versions.ts)_
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/config/versions.ts)_

## `asyncapi convert [SPEC-FILE]`

Expand All @@ -318,7 +323,7 @@ DESCRIPTION
Convert asyncapi documents older to newer versions
```

_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/convert.ts)_
_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/convert.ts)_

## `asyncapi diff OLD NEW`

Expand Down Expand Up @@ -373,7 +378,7 @@ DESCRIPTION
Find diff between two asyncapi files
```

_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/diff.ts)_
_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/diff.ts)_

## `asyncapi generate`

Expand All @@ -387,7 +392,7 @@ DESCRIPTION
Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.
```

_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/generate/index.ts)_
_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/generate/index.ts)_

## `asyncapi generate fromTemplate [ASYNCAPI] [TEMPLATE]`

Expand Down Expand Up @@ -417,6 +422,9 @@ FLAGS
unstaged files or not empty dir (defaults to false)
--map-base-url=<value> Maps all schema references from base url to local folder
--no-interactive Disable interactive mode and run with the provided flags.
--registry-url Specifies the URL of the private registry for fetching templates and dependencies
--registry-auth The registry username and password encoded with base64, formatted as username:password
--registry-token The npm registry authentication token, that can be passed instead of base64 encoded username and password
DESCRIPTION
Generates whatever you want using templates compatible with AsyncAPI Generator.
Expand All @@ -425,7 +433,7 @@ EXAMPLES
$ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write
```

_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/generate/fromTemplate.ts)_
_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/generate/fromTemplate.ts)_

## `asyncapi generate models [LANGUAGE] [FILE]`

Expand Down Expand Up @@ -511,7 +519,7 @@ DESCRIPTION
Generates typed models
```

_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/generate/models.ts)_
_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/generate/models.ts)_

## `asyncapi new`

Expand Down Expand Up @@ -568,7 +576,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/new/index.ts)_
_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/new/index.ts)_

## `asyncapi new file`

Expand Down Expand Up @@ -625,7 +633,7 @@ EXAMPLES
$ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode
```

_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/new/file.ts)_
_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/new/file.ts)_

## `asyncapi new glee`

Expand All @@ -647,7 +655,7 @@ DESCRIPTION
Creates a new Glee project
```

_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/new/glee.ts)_
_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/new/glee.ts)_

## `asyncapi optimize [SPEC-FILE]`

Expand Down Expand Up @@ -685,7 +693,7 @@ EXAMPLES
$ asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty
```

_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/optimize.ts)_
_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/optimize.ts)_

## `asyncapi start`

Expand All @@ -699,7 +707,7 @@ DESCRIPTION
Start asyncapi studio
```

_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/start/index.ts)_
_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/start/index.ts)_

## `asyncapi start studio`

Expand All @@ -718,7 +726,7 @@ DESCRIPTION
starts a new local instance of Studio
```

_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/start/studio.ts)_
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/start/studio.ts)_

## `asyncapi validate [SPEC-FILE]`

Expand All @@ -745,5 +753,5 @@ DESCRIPTION
validate asyncapi file
```

_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.11.0/src/commands/validate.ts)_
_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.12.2/src/commands/validate.ts)_
<!-- commandsstop -->
Loading

0 comments on commit 6e37a36

Please sign in to comment.