Skip to content

Commit a4c021b

Browse files
asyncapi-bot-eveasyncapi-bot-eve
authored
Merge master into bot/bump-@asyncapi/modelina-2.0.2
2 parents e93f786 + 58f6e2a commit a4c021b

File tree

7 files changed

+377
-1
lines changed

7 files changed

+377
-1
lines changed

‎.github/workflows/deploy/chocolatey/asyncapi-cli.nuspec

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- Do not remove this test for UTF-8: if “Ω” doesn’t appear as greek uppercase omega letter enclosed in quotation marks, you should use an editor that supports UTF-8, not this one. -->
3+
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
4+
<metadata>
5+
<id>asyncapi</id>
6+
<version>{{version}}</version>
7+
<packageSourceUrl>https://github.com/asyncapi/cli/releases</packageSourceUrl>
8+
<owners>AsyncAPI, shurtugal</owners>
9+
10+
<!-- == SOFTWARE SPECIFIC SECTION == -->
11+
<!-- This section is about the software itself -->
12+
<title>asyncapi-cli</title>
13+
<authors>AsyncAPI, shurtugal</authors>
14+
<projectUrl>https://www.asyncapi.com/</projectUrl>
15+
<iconUrl>https://avatars.githubusercontent.com/u/16401334?s=200</iconUrl>
16+
<copyright>2023 AsyncAPI</copyright>
17+
<licenseUrl>https://github.com/asyncapi/cli/blob/master/LICENSE</licenseUrl>
18+
<requireLicenseAcceptance>false</requireLicenseAcceptance>
19+
<projectSourceUrl>https://github.com/asyncapi/cli</projectSourceUrl>
20+
<docsUrl>https://www.asyncapi.com/docs/tools/cli</docsUrl>
21+
<bugTrackerUrl>https://github.com/asyncapi/cli/issues/new/choose</bugTrackerUrl>
22+
<tags>asyncapi-cli cli nodejs api asyncapi</tags>
23+
<description>CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!</description>
24+
</metadata>
25+
<files>
26+
<!-- this section controls what actually gets packaged into the Chocolatey package -->
27+
<file src="tools\**" target="tools" />
28+
</files>
29+
</package>

‎.github/workflows/deploy/chocolatey/replace.ps1

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
param (
2+
[Parameter(Mandatory=$true)]
3+
[string]$version
4+
)
5+
6+
$filePaths = @(
7+
'./tools/chocolateyinstall.ps1'
8+
'./asyncapi-cli.nuspec'
9+
)
10+
11+
foreach ($filePath in $filePaths) {
12+
$fileContents = Get-Content $filePath
13+
$fileContents = $fileContents -replace '{{version}}', $version
14+
Set-Content $filePath $fileContents
15+
}

‎.github/workflows/deploy/chocolatey/tools/LICENSE.txt

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+

2+
From: https://github.com/asyncapi/cli/blob/master/LICENSE
3+
4+
LICENSE
5+
6+
Apache License
7+
Version 2.0, January 2004
8+
http://www.apache.org/licenses/
9+
10+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11+
12+
1. Definitions.
13+
14+
"License" shall mean the terms and conditions for use, reproduction,
15+
and distribution as defined by Sections 1 through 9 of this document.
16+
17+
"Licensor" shall mean the copyright owner or entity authorized by
18+
the copyright owner that is granting the License.
19+
20+
"Legal Entity" shall mean the union of the acting entity and all
21+
other entities that control, are controlled by, or are under common
22+
control with that entity. For the purposes of this definition,
23+
"control" means (i) the power, direct or indirect, to cause the
24+
direction or management of such entity, whether by contract or
25+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
26+
outstanding shares, or (iii) beneficial ownership of such entity.
27+
28+
"You" (or "Your") shall mean an individual or Legal Entity
29+
exercising permissions granted by this License.
30+
31+
"Source" form shall mean the preferred form for making modifications,
32+
including but not limited to software source code, documentation
33+
source, and configuration files.
34+
35+
"Object" form shall mean any form resulting from mechanical
36+
transformation or translation of a Source form, including but
37+
not limited to compiled object code, generated documentation,
38+
and conversions to other media types.
39+
40+
"Work" shall mean the work of authorship, whether in Source or
41+
Object form, made available under the License, as indicated by a
42+
copyright notice that is included in or attached to the work
43+
(an example is provided in the Appendix below).
44+
45+
"Derivative Works" shall mean any work, whether in Source or Object
46+
form, that is based on (or derived from) the Work and for which the
47+
editorial revisions, annotations, elaborations, or other modifications
48+
represent, as a whole, an original work of authorship. For the purposes
49+
of this License, Derivative Works shall not include works that remain
50+
separable from, or merely link (or bind by name) to the interfaces of,
51+
the Work and Derivative Works thereof.
52+
53+
"Contribution" shall mean any work of authorship, including
54+
the original version of the Work and any modifications or additions
55+
to that Work or Derivative Works thereof, that is intentionally
56+
submitted to Licensor for inclusion in the Work by the copyright owner
57+
or by an individual or Legal Entity authorized to submit on behalf of
58+
the copyright owner. For the purposes of this definition, "submitted"
59+
means any form of electronic, verbal, or written communication sent
60+
to the Licensor or its representatives, including but not limited to
61+
communication on electronic mailing lists, source code control systems,
62+
and issue tracking systems that are managed by, or on behalf of, the
63+
Licensor for the purpose of discussing and improving the Work, but
64+
excluding communication that is conspicuously marked or otherwise
65+
designated in writing by the copyright owner as "Not a Contribution."
66+
67+
"Contributor" shall mean Licensor and any individual or Legal Entity
68+
on behalf of whom a Contribution has been received by Licensor and
69+
subsequently incorporated within the Work.
70+
71+
2. Grant of Copyright License. Subject to the terms and conditions of
72+
this License, each Contributor hereby grants to You a perpetual,
73+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74+
copyright license to reproduce, prepare Derivative Works of,
75+
publicly display, publicly perform, sublicense, and distribute the
76+
Work and such Derivative Works in Source or Object form.
77+
78+
3. Grant of Patent License. Subject to the terms and conditions of
79+
this License, each Contributor hereby grants to You a perpetual,
80+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81+
(except as stated in this section) patent license to make, have made,
82+
use, offer to sell, sell, import, and otherwise transfer the Work,
83+
where such license applies only to those patent claims licensable
84+
by such Contributor that are necessarily infringed by their
85+
Contribution(s) alone or by combination of their Contribution(s)
86+
with the Work to which such Contribution(s) was submitted. If You
87+
institute patent litigation against any entity (including a
88+
cross-claim or counterclaim in a lawsuit) alleging that the Work
89+
or a Contribution incorporated within the Work constitutes direct
90+
or contributory patent infringement, then any patent licenses
91+
granted to You under this License for that Work shall terminate
92+
as of the date such litigation is filed.
93+
94+
4. Redistribution. You may reproduce and distribute copies of the
95+
Work or Derivative Works thereof in any medium, with or without
96+
modifications, and in Source or Object form, provided that You
97+
meet the following conditions:
98+
99+
(a) You must give any other recipients of the Work or
100+
Derivative Works a copy of this License; and
101+
102+
(b) You must cause any modified files to carry prominent notices
103+
stating that You changed the files; and
104+
105+
(c) You must retain, in the Source form of any Derivative Works
106+
that You distribute, all copyright, patent, trademark, and
107+
attribution notices from the Source form of the Work,
108+
excluding those notices that do not pertain to any part of
109+
the Derivative Works; and
110+
111+
(d) If the Work includes a "NOTICE" text file as part of its
112+
distribution, then any Derivative Works that You distribute must
113+
include a readable copy of the attribution notices contained
114+
within such NOTICE file, excluding those notices that do not
115+
pertain to any part of the Derivative Works, in at least one
116+
of the following places: within a NOTICE text file distributed
117+
as part of the Derivative Works; within the Source form or
118+
documentation, if provided along with the Derivative Works; or,
119+
within a display generated by the Derivative Works, if and
120+
wherever such third-party notices normally appear. The contents
121+
of the NOTICE file are for informational purposes only and
122+
do not modify the License. You may add Your own attribution
123+
notices within Derivative Works that You distribute, alongside
124+
or as an addendum to the NOTICE text from the Work, provided
125+
that such additional attribution notices cannot be construed
126+
as modifying the License.
127+
128+
You may add Your own copyright statement to Your modifications and
129+
may provide additional or different license terms and conditions
130+
for use, reproduction, or distribution of Your modifications, or
131+
for any such Derivative Works as a whole, provided Your use,
132+
reproduction, and distribution of the Work otherwise complies with
133+
the conditions stated in this License.
134+
135+
5. Submission of Contributions. Unless You explicitly state otherwise,
136+
any Contribution intentionally submitted for inclusion in the Work
137+
by You to the Licensor shall be under the terms and conditions of
138+
this License, without any additional terms or conditions.
139+
Notwithstanding the above, nothing herein shall supersede or modify
140+
the terms of any separate license agreement you may have executed
141+
with Licensor regarding such Contributions.
142+
143+
6. Trademarks. This License does not grant permission to use the trade
144+
names, trademarks, service marks, or product names of the Licensor,
145+
except as required for reasonable and customary use in describing the
146+
origin of the Work and reproducing the content of the NOTICE file.
147+
148+
7. Disclaimer of Warranty. Unless required by applicable law or
149+
agreed to in writing, Licensor provides the Work (and each
150+
Contributor provides its Contributions) on an "AS IS" BASIS,
151+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152+
implied, including, without limitation, any warranties or conditions
153+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154+
PARTICULAR PURPOSE. You are solely responsible for determining the
155+
appropriateness of using or redistributing the Work and assume any
156+
risks associated with Your exercise of permissions under this License.
157+
158+
8. Limitation of Liability. In no event and under no legal theory,
159+
whether in tort (including negligence), contract, or otherwise,
160+
unless required by applicable law (such as deliberate and grossly
161+
negligent acts) or agreed to in writing, shall any Contributor be
162+
liable to You for damages, including any direct, indirect, special,
163+
incidental, or consequential damages of any character arising as a
164+
result of this License or out of the use or inability to use the
165+
Work (including but not limited to damages for loss of goodwill,
166+
work stoppage, computer failure or malfunction, or any and all
167+
other commercial damages or losses), even if such Contributor
168+
has been advised of the possibility of such damages.
169+
170+
9. Accepting Warranty or Additional Liability. While redistributing
171+
the Work or Derivative Works thereof, You may choose to offer,
172+
and charge a fee for, acceptance of support, warranty, indemnity,
173+
or other liability obligations and/or rights consistent with this
174+
License. However, in accepting such obligations, You may act only
175+
on Your own behalf and on Your sole responsibility, not on behalf
176+
of any other Contributor, and only if You agree to indemnify,
177+
defend, and hold each Contributor harmless for any liability
178+
incurred by, or claims asserted against, such Contributor by reason
179+
of your accepting any such warranty or additional liability.
180+
181+
END OF TERMS AND CONDITIONS
182+
183+
APPENDIX: How to apply the Apache License to your work.
184+
185+
To apply the Apache License to your work, attach the following
186+
boilerplate notice, with the fields enclosed by brackets "[]"
187+
replaced with your own identifying information. (Don't include
188+
the brackets!) The text should be enclosed in the appropriate
189+
comment syntax for the file format. We also recommend that a
190+
file or class name and description of purpose be included on the
191+
same "printed page" as the copyright notice for easier
192+
identification within third-party archives.
193+
194+
Copyright [yyyy] [name of copyright owner]
195+
196+
Licensed under the Apache License, Version 2.0 (the "License");
197+
you may not use this file except in compliance with the License.
198+
You may obtain a copy of the License at
199+
200+
http://www.apache.org/licenses/LICENSE-2.0
201+
202+
Unless required by applicable law or agreed to in writing, software
203+
distributed under the License is distributed on an "AS IS" BASIS,
204+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205+
See the License for the specific language governing permissions and
206+
limitations under the License.
207+

‎.github/workflows/deploy/chocolatey/tools/VERIFICATION.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
VERIFICATION
2+
Verification is intended to assist the Chocolatey moderators and community
3+
in verifying that this package's contents are trustworthy.

‎.github/workflows/deploy/chocolatey/tools/chocolateyinstall.ps1

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
$ErrorActionPreference = 'Stop' # stop on all errors
2+
$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
3+
4+
$url = 'https://github.com/asyncapi/cli/releases/download/v{{version}}/asyncapi.x86.exe'
5+
$url64 = 'https://github.com/asyncapi/cli/releases/download/v{{version}}/asyncapi.x64.exe'
6+
7+
$packageArgs = @{
8+
packageName = $env:ChocolateyPackageName
9+
unzipLocation = $toolsDir
10+
fileType = 'EXE'
11+
url = $url
12+
url64bit = $url64
13+
#file = $fileLocation NOTE: Commented out because we are using url instead
14+
15+
softwareName = 'asyncapi-cli*' #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique
16+
17+
# TODO :- Change the checksum and checksumType to match the checksums for the above file.
18+
# checksum = ''
19+
# checksumType = 'sha256' #default is md5, can also be sha1, sha256 or sha512
20+
# checksum64 = ''
21+
# checksumType64= 'sha256' #default is checksumType
22+
23+
# MSI
24+
# silentArgs = "/qn /norestart /l*v `"$($env:TEMP)\$($packageName).$($env:chocolateyPackageVersion).MsiInstall.log`"" # ALLUSERS=1 DISABLEDESKTOPSHORTCUT=1 ADDDESKTOPICON=0 ADDSTARTMENU=0
25+
validExitCodes= @(0, 3010, 1641)
26+
# OTHERS
27+
# Uncomment matching EXE type (sorted by most to least common)
28+
silentArgs = '/S' # NSIS
29+
#silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup
30+
#silentArgs = '/s' # InstallShield
31+
#silentArgs = '/s /v"/qn"' # InstallShield with MSI
32+
#silentArgs = '/s' # Wise InstallMaster
33+
#silentArgs = '-s' # Squirrel
34+
#silentArgs = '-q' # Install4j
35+
#silentArgs = '-s' # Ghost
36+
# Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence.
37+
#silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK)
38+
# https://community.chocolatey.org/packages/autohotkey.portable
39+
#validExitCodes= @(0) #please insert other valid exit codes here
40+
}
41+
42+
Install-ChocolateyPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage

‎.github/workflows/release-chocolatey.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Release Chocolatey Package
2+
on:
3+
# We cannot run chocolatey release continusly every time we release something as sometimes we release a couple of times a day and overload chocolatey pipelines
4+
# More details https://github.com/asyncapi/cli/issues/503
5+
schedule:
6+
- cron: '0 23 * * *' # Run every day at 23:00 UTC
7+
# Since now release depends on schedule, might be that there is a situation we cannot wait for schedule and trigger release manually
8+
workflow_dispatch:
9+
inputs:
10+
version:
11+
description: 'Version to release (optional)'
12+
required: false
13+
14+
jobs:
15+
release:
16+
name: Publish to Chocolatey Community
17+
runs-on: windows-latest
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v3
21+
- name: Set Version
22+
id: release_version
23+
run: |
24+
if ( "${{ github.event_name }}" -eq "workflow_dispatch" -and "${{ github.event.inputs.version }}" -ne "" ) {
25+
$version = "${{ github.event.inputs.version }}"
26+
}
27+
else {
28+
$version = $(npm pkg get version)
29+
}
30+
echo "Setting version to $version"
31+
echo "version=$version" >> $env:GITHUB_OUTPUT
32+
- name: Make nuspec from the template
33+
run: |
34+
cd ./.github/workflows/deploy/chocolatey
35+
pwsh -File ./replace.ps1 -version ${{ steps.release_version.outputs.version }}
36+
- name: Run Chocolatey Pack
37+
run: |
38+
cd ./.github/workflows/deploy/chocolatey
39+
choco pack ./asyncapi-cli.nuspec
40+
choco apikey add --source "'https://push.chocolatey.org/'" --key ${{ secrets.CHOCOLATEY_API_KEY }}
41+
choco push ./asyncapi.${{ steps.release_version.outputs.version }}.nupkg --source "'https://push.chocolatey.org/'"
42+
- if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel
43+
name: Report workflow run status to Slack
44+
uses: 8398a7/action-slack@fbd6aa58ba854a740e11a35d0df80cb5d12101d8 #using https://github.com/8398a7/action-slack/releases/tag/v3.15.1
45+
with:
46+
status: ${{ job.status }}
47+
fields: repo,action,workflow
48+
text: 'AsyncAPI CLI release to Chocolatey failed'
49+
env:
50+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}

‎docs/installation.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,40 @@ sudo installer -pkg asyncapi.pkg -target /
9292
```
9393

9494
## Windows
95-
For Windows just install the appropriate installer and simply follow the default installation steps to complete the installation process.
95+
96+
There are two ways to install the AsyncAPI CLI on your Windows operating system: using the `chocolatey` package manager or executable files.
97+
98+
### Chocolatey
99+
100+
Prerequisites:
101+
[Chocolatey](https://chocolatey.org/install) must be installed on your Windows operating system. The installation instructions can be found [here](https://docs.chocolatey.org/en-us/choco/setup#installing-chocolatey-cli).
102+
103+
To install the AsyncAPI CLI using the `chocolatey` package manager, run the following command in your terminal with administrator privileges:
104+
105+
```sh
106+
# Install AsyncAPI CLI
107+
choco install asyncapi
108+
```
109+
110+
To upgrade run this command:-
111+
```sh
112+
# Upgrade AsyncAPI CLI
113+
choco upgrade asyncapi
114+
```
115+
To install a specific version run this command:
116+
```sh
117+
# Install AsyncAPI CLI version xx.xx.xx
118+
choco install asyncapi --version xx.xx.xx
119+
```
120+
All the AsyncAPI CLI versions can be found [here](https://chocolatey.org/packages/asyncapi).
121+
122+
### Executable files
123+
124+
Just install the appropriate installer and simply follow the default installation steps to complete the installation process.
96125

97126
Download [asyncapi.x64.exe](https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x64.exe) for 64-bit Windows and download [asyncapi.x86.exe](https://github.com/asyncapi/cli/releases/latest/download/asyncapi.x86.exe) for 32-bit Windows.
98127

128+
99129
## Linux
100130
Selecting the appropriate AsyncAPI CLI installation method on a Linux operating system depends on your Linux distro.
101131

0 commit comments

Comments
 (0)