Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

meta(vscode): Add pipeline to test and build private feature vsix #6427

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ccastrotrejo
Copy link
Contributor

@ccastrotrejo ccastrotrejo commented Jan 17, 2025

This pull request introduces a new GitHub Actions workflow to automate the building and testing of a private VSIX (Visual Studio Code extension) package. The workflow is designed to run tests on different Node.js versions and build the VSIX package with specific configurations.

Why having new pipeline

The idea is to have a pipeline in which creates a VSIX that closely resembles a release version. This pipeline requires a branch name as input, runs the tests, and builds the VSIX in GitHub. As a result, we will be able to distribute a more solid private vsix

New GitHub Actions Workflow:

  • Added a new workflow named "Private vsix build" that includes two jobs: test and build. The test job runs on multiple Node.js versions (18.x, 20.x, 22.x) and caches the turbo build setup. The build job sets up Node.js version 20, replaces placeholders with the telemetry key, and packs the VSCode Designer Extension.

workflow_dispatch: # Trigger only manually workflow_dispatch: # Trigger only manually

env:
AI_KEY: 3cf0d6ae-3327-414a-b7c1-12f31ef45eff
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this a secret? should we be storing it in source?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

especially on open source github

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The AI key is not a secret, we already have it in the repo, according to the telemetry package that vscode offers is not sensitive

The AI key is not a secret; it’s already in the repository. According to the telemetry package provided by VS Code, it is not considered sensitive information. For more details, you can refer to the VS Code extension telemetry documentation.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say we should still add this to a variable in case we need to change it in future. Will be handy without changing the code. If it is not a secret, the value can be set as a variable instead of secret

@ccastrotrejo ccastrotrejo changed the title meta(vscode): Create pipeline to test and build private feature vsix meta(vscode): Add pipeline to test and build private feature vsix Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants