-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Setup GitHub Action Workflow to package, release and publish the extension
- Loading branch information
1 parent
88a3a30
commit 7c98d11
Showing
3 changed files
with
100 additions
and
45 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| name: Release | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - v* | ||
|
|
||
| jobs: | ||
| release-vsix: | ||
| name: Release & Publish | ||
| runs-on: ubuntu-latest | ||
| if: github.repository == 'sarvalabs/vscode-coco' | ||
|
|
||
| steps: | ||
| - name: Clone repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: '18' | ||
| cache: 'npm' | ||
|
|
||
| - name: Install dependencies | ||
| run: npm install | ||
|
|
||
| - name: Obtain release version | ||
| id: release_version | ||
| run: | | ||
| TAGGED_VERSION="${GITHUB_REF/refs\/tags\/v/}" | ||
| if [[ ! "${TAGGED_VERSION}" =~ ^[0-9]+\.[0-9]+\.[0-9]+.*$ ]]; then | ||
| echo "Invalid version tag '${TAGGED_VERSION}'" | ||
| exit 1 | ||
| fi | ||
| echo "EXT_VERSION=${TAGGED_VERSION}" >> $GITHUB_ENV | ||
| WRITTEN_VERSION="$(cat package.json | jq '.version' -r)" | ||
| if [[ "${TAGGED_VERSION}" == *"-"* ]]; then | ||
| if [[ ! "${TAGGED_VERSION}" == "${WRITTEN_VERSION}"-rc.* ]]; then | ||
| echo "pre-release tag and version in package.json are not compatible: '${TAGGED_VERSION}' vs '${WRITTEN_VERSION}'" | ||
| exit 1 | ||
| fi | ||
| echo "EXT_ISPREVIEW=1" >> $GITHUB_ENV | ||
| else | ||
| if [[ "${TAGGED_VERSION}" != "${WRITTEN_VERSION}" ]]; then | ||
| echo "release tag and version in package.json do not match: '${TAGGED_VERSION}' vs '${WRITTEN_VERSION}'" | ||
| exit 1 | ||
| fi | ||
| echo "EXT_ISPREVIEW=0" >> $GITHUB_ENV | ||
| fi | ||
| - name: Package VSIX | ||
| run: npx vsce package -o "./coco-${{ env.EXT_VERSION }}.vsix" | ||
|
|
||
| - name: Upload VSIX to Release Assets | ||
| uses: softprops/action-gh-release@v1 | ||
| if: ${{startsWith(github.ref, 'refs/tags/') }} | ||
| with: | ||
| name: Release ${{ env.EXT_VERSION }} | ||
| files: coco-${{ env.EXT_VERSION }}.vsix | ||
| prerelease: ${{env.EXT_ISPREVIEW == 1}} | ||
|
|
||
| - name: Publish to VS Code Extension Marketplace | ||
| if: env.EXT_ISPREVIEW != 1 && github.repository == 'sarvalabs/vscode-coco' | ||
| run: npx vsce publish -i "./coco-${{ env.EXT_VERSION }}.vsix" -p "${{ secrets.VSCE_TOKEN }}" |
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,49 +1,37 @@ | ||
| # Coco for Visual Studio Code | ||
| # Cocolang for Visual Studio Code | ||
|
|
||
|  | ||
|  | ||
|  | ||
| [latestrelease]: https://github.com/sarvalabs/vscode-coco/releases/latest | ||
| [issueslink]: https://github.com/sarvalabs/vscode-coco/issues | ||
| [marketplace]: https://marketplace.visualstudio.com/items?itemName=sarvalabs.cocolang | ||
|
|
||
| The VS Code Coco extension provides syntax highlighting for the [Coco programming language](http://cocolang.dev). | ||
| [](./LICENSE) | ||
| [][latestrelease] | ||
|  | ||
| [][issueslink] | ||
|
|
||
| **NOTE**: Currently, it must be manually installed using a `.vsix` file. We are actively working to publish this | ||
| extension on the Visual Studio Code Marketplace. | ||
| The VS Code Cocolang extension provides syntax highlighting for the [Coco programming language](http://cocolang.dev). | ||
|
|
||
| ### Requirements | ||
| - [Visual Studio Code](https://code.visualstudio.com/download) (v0.1.59 or greater) | ||
| ### Install from the Extension Marketplace | ||
| This extension can be installed from the Visual Studio Code Extension Marketplace [here][marketplace]. | ||
|
|
||
| ### Installation | ||
| Install the extension manually with the `.vsix` file available in the releases. | ||
| ### Install from a VSIX | ||
| A `.vsix` files comes bundled with every release and can be downloaded from [here][latestrelease]. | ||
|
|
||
| 1. Download the latest release of the Coco extension from the [releases](https://github.com/sarvalabs/vscode-coco/releases) | ||
| 2. Open Visual Studio Code. | ||
| 3. In Visual Studio Code, go to the Extensions View by clicking on the Extensions icon in the Activity Bar on the side | ||
| of the window or using the shortcut `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (Mac). | ||
| 4. Click on the three dots menu icon (⋮) in the Extensions View's top-right corner, and select "Install from VSIX." | ||
| 5. Browse to the location where you downloaded the Coco VSIX extension `.vsix` file, select it, and click "Open." | ||
| 6. The Coco extension will now be installed in Visual Studio Code. | ||
| Alternatively, it can be built from this repository source with the following command (requires NPM) | ||
| resulting in the creation of a file named a file `coco-v*.*.*.vsix` with the release version. | ||
| ```bash | ||
| npm run package | ||
| ``` | ||
|
|
||
| ### Using the Extension | ||
| To use the Coco extension, follow these steps: | ||
| However, you obtain the `.vsix` file, it can then be used to install the extension to Visual Studio | ||
| Code using the following command. Read more [here](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) | ||
| for other ways to install from a VSIX | ||
| ```bash | ||
| code --install-extension coco.vsix | ||
| ``` | ||
|
|
||
| 1. Open a project or file in Visual Studio Code that is relevant to the functionality provided by the extension. | ||
| 2. The Coco extension should automatically start working if it has any features that apply to the current project | ||
| or file. Otherwise, you may need to trigger the extension manually by interacting with its commands, settings, or | ||
| other integration points. | ||
| 3. Refer to the extension's documentation or the README file of the Coco extension's GitHub repository to learn | ||
| about its specific features and how to use them effectively. | ||
|
|
||
| ### Uninstalling the Extension | ||
| If you want to uninstall the Coco extension, follow these steps: | ||
|
|
||
| 1. Open Visual Studio Code. | ||
| 2. Go to the Extensions View by clicking on the Extensions icon in the Activity Bar on the side of the window or | ||
| using the shortcut `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (Mac). | ||
| 3. Find the installed Coco extension in the Extensions View. | ||
| 4. Click on the gear icon next to the Coco extension's name and select "Uninstall." | ||
| 5. Confirm the uninstallation when prompted. | ||
|
|
||
| ### Feedback and Issues | ||
| If you encounter any issues with the Coco extension or have suggestions for improvements, please check | ||
| the extension's [GitHub repository](https://github.com/sarvalabs/vscode-coco) for issue tracking. | ||
| If you encounter any issues with the Cocolang extension or have suggestions for improvements, please | ||
| check the extension's [GitHub repository](https://github.com/sarvalabs/vscode-coco) for issue tracking. | ||
| You can open a new issue to report problems or submit feature requests. |
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