From 58f6e2aa6f048c3aa90a1e31b4ef6b09e19e3eab Mon Sep 17 00:00:00 2001 From: Ashish Padhy <100484401+Shurtu-gal@users.noreply.github.com> Date: Tue, 7 Nov 2023 18:13:56 +0530 Subject: [PATCH] feat: add chocolatey support (#847) --- .../deploy/chocolatey/asyncapi-cli.nuspec | 29 +++ .../workflows/deploy/chocolatey/replace.ps1 | 15 ++ .../deploy/chocolatey/tools/LICENSE.txt | 207 ++++++++++++++++++ .../deploy/chocolatey/tools/VERIFICATION.txt | 3 + .../chocolatey/tools/chocolateyinstall.ps1 | 42 ++++ .github/workflows/release-chocolatey.yml | 50 +++++ docs/installation.md | 32 ++- 7 files changed, 377 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/deploy/chocolatey/asyncapi-cli.nuspec create mode 100644 .github/workflows/deploy/chocolatey/replace.ps1 create mode 100644 .github/workflows/deploy/chocolatey/tools/LICENSE.txt create mode 100644 .github/workflows/deploy/chocolatey/tools/VERIFICATION.txt create mode 100644 .github/workflows/deploy/chocolatey/tools/chocolateyinstall.ps1 create mode 100644 .github/workflows/release-chocolatey.yml diff --git a/.github/workflows/deploy/chocolatey/asyncapi-cli.nuspec b/.github/workflows/deploy/chocolatey/asyncapi-cli.nuspec new file mode 100644 index 00000000000..f15e171f812 --- /dev/null +++ b/.github/workflows/deploy/chocolatey/asyncapi-cli.nuspec @@ -0,0 +1,29 @@ + + + + + asyncapi + {{version}} + https://github.com/asyncapi/cli/releases + AsyncAPI, shurtugal + + + + asyncapi-cli + AsyncAPI, shurtugal + https://www.asyncapi.com/ + https://avatars.githubusercontent.com/u/16401334?s=200 + 2023 AsyncAPI + https://github.com/asyncapi/cli/blob/master/LICENSE + false + https://github.com/asyncapi/cli + https://www.asyncapi.com/docs/tools/cli + https://github.com/asyncapi/cli/issues/new/choose + asyncapi-cli cli nodejs api asyncapi + 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! + + + + + + diff --git a/.github/workflows/deploy/chocolatey/replace.ps1 b/.github/workflows/deploy/chocolatey/replace.ps1 new file mode 100644 index 00000000000..fcacc27eac8 --- /dev/null +++ b/.github/workflows/deploy/chocolatey/replace.ps1 @@ -0,0 +1,15 @@ +param ( + [Parameter(Mandatory=$true)] + [string]$version +) + +$filePaths = @( + './tools/chocolateyinstall.ps1' + './asyncapi-cli.nuspec' +) + +foreach ($filePath in $filePaths) { + $fileContents = Get-Content $filePath + $fileContents = $fileContents -replace '{{version}}', $version + Set-Content $filePath $fileContents +} \ No newline at end of file diff --git a/.github/workflows/deploy/chocolatey/tools/LICENSE.txt b/.github/workflows/deploy/chocolatey/tools/LICENSE.txt new file mode 100644 index 00000000000..ba119f5d837 --- /dev/null +++ b/.github/workflows/deploy/chocolatey/tools/LICENSE.txt @@ -0,0 +1,207 @@ + +From: https://github.com/asyncapi/cli/blob/master/LICENSE + +LICENSE + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/.github/workflows/deploy/chocolatey/tools/VERIFICATION.txt b/.github/workflows/deploy/chocolatey/tools/VERIFICATION.txt new file mode 100644 index 00000000000..38590d5dfa0 --- /dev/null +++ b/.github/workflows/deploy/chocolatey/tools/VERIFICATION.txt @@ -0,0 +1,3 @@ +VERIFICATION +Verification is intended to assist the Chocolatey moderators and community +in verifying that this package's contents are trustworthy. \ No newline at end of file diff --git a/.github/workflows/deploy/chocolatey/tools/chocolateyinstall.ps1 b/.github/workflows/deploy/chocolatey/tools/chocolateyinstall.ps1 new file mode 100644 index 00000000000..13c7c049e3d --- /dev/null +++ b/.github/workflows/deploy/chocolatey/tools/chocolateyinstall.ps1 @@ -0,0 +1,42 @@ +$ErrorActionPreference = 'Stop' # stop on all errors +$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" + +$url = 'https://github.com/asyncapi/cli/releases/download/v{{version}}/asyncapi.x86.exe' +$url64 = 'https://github.com/asyncapi/cli/releases/download/v{{version}}/asyncapi.x64.exe' + +$packageArgs = @{ + packageName = $env:ChocolateyPackageName + unzipLocation = $toolsDir + fileType = 'EXE' + url = $url + url64bit = $url64 + #file = $fileLocation NOTE: Commented out because we are using url instead + + 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 + + # TODO :- Change the checksum and checksumType to match the checksums for the above file. + # checksum = '' + # checksumType = 'sha256' #default is md5, can also be sha1, sha256 or sha512 + # checksum64 = '' + # checksumType64= 'sha256' #default is checksumType + + # MSI + # silentArgs = "/qn /norestart /l*v `"$($env:TEMP)\$($packageName).$($env:chocolateyPackageVersion).MsiInstall.log`"" # ALLUSERS=1 DISABLEDESKTOPSHORTCUT=1 ADDDESKTOPICON=0 ADDSTARTMENU=0 + validExitCodes= @(0, 3010, 1641) + # OTHERS + # Uncomment matching EXE type (sorted by most to least common) + silentArgs = '/S' # NSIS + #silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup + #silentArgs = '/s' # InstallShield + #silentArgs = '/s /v"/qn"' # InstallShield with MSI + #silentArgs = '/s' # Wise InstallMaster + #silentArgs = '-s' # Squirrel + #silentArgs = '-q' # Install4j + #silentArgs = '-s' # Ghost + # Note that some installers, in addition to the silentArgs above, may also need assistance of AHK to achieve silence. + #silentArgs = '' # none; make silent with input macro script like AutoHotKey (AHK) + # https://community.chocolatey.org/packages/autohotkey.portable + #validExitCodes= @(0) #please insert other valid exit codes here +} + +Install-ChocolateyPackage @packageArgs # https://docs.chocolatey.org/en-us/create/functions/install-chocolateypackage diff --git a/.github/workflows/release-chocolatey.yml b/.github/workflows/release-chocolatey.yml new file mode 100644 index 00000000000..b660240565c --- /dev/null +++ b/.github/workflows/release-chocolatey.yml @@ -0,0 +1,50 @@ +name: Release Chocolatey Package +on: + # 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 + # More details https://github.com/asyncapi/cli/issues/503 + schedule: + - cron: '0 23 * * *' # Run every day at 23:00 UTC + # Since now release depends on schedule, might be that there is a situation we cannot wait for schedule and trigger release manually + workflow_dispatch: + inputs: + version: + description: 'Version to release (optional)' + required: false + +jobs: + release: + name: Publish to Chocolatey Community + runs-on: windows-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Set Version + id: release_version + run: | + if ( "${{ github.event_name }}" -eq "workflow_dispatch" -and "${{ github.event.inputs.version }}" -ne "" ) { + $version = "${{ github.event.inputs.version }}" + } + else { + $version = $(npm pkg get version) + } + echo "Setting version to $version" + echo "version=$version" >> $env:GITHUB_OUTPUT + - name: Make nuspec from the template + run: | + cd ./.github/workflows/deploy/chocolatey + pwsh -File ./replace.ps1 -version ${{ steps.release_version.outputs.version }} + - name: Run Chocolatey Pack + run: | + cd ./.github/workflows/deploy/chocolatey + choco pack ./asyncapi-cli.nuspec + choco apikey add --source "'https://push.chocolatey.org/'" --key ${{ secrets.CHOCOLATEY_API_KEY }} + choco push ./asyncapi.${{ steps.release_version.outputs.version }}.nupkg --source "'https://push.chocolatey.org/'" + - if: failure() # Only, on failure, send a message on the 94_bot-failing-ci slack channel + name: Report workflow run status to Slack + 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 CLI release to Chocolatey failed' + env: + SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }} \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index 04d94400f2e..5b954799ca3 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -92,10 +92,40 @@ sudo installer -pkg asyncapi.pkg -target / ``` ## Windows -For Windows just install the appropriate installer and simply follow the default installation steps to complete the installation process. + +There are two ways to install the AsyncAPI CLI on your Windows operating system: using the `chocolatey` package manager or executable files. + +### Chocolatey + +Prerequisites: +[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). + +To install the AsyncAPI CLI using the `chocolatey` package manager, run the following command in your terminal with administrator privileges: + +```sh +# Install AsyncAPI CLI +choco install asyncapi +``` + +To upgrade run this command:- +```sh +# Upgrade AsyncAPI CLI +choco upgrade asyncapi +``` +To install a specific version run this command: +```sh +# Install AsyncAPI CLI version xx.xx.xx +choco install asyncapi --version xx.xx.xx +``` +All the AsyncAPI CLI versions can be found [here](https://chocolatey.org/packages/asyncapi). + +### Executable files + +Just install the appropriate installer and simply follow the default installation steps to complete the installation process. 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. + ## Linux Selecting the appropriate AsyncAPI CLI installation method on a Linux operating system depends on your Linux distro.