roku-debug 0.21.28 → 0.21.29

package/nested-ci/.github/workflows/delete-release.yml

@@ -0,0 +1,35 @@
+name: Delete Release
+
+on:
+  workflow_call:
+    inputs:
+      version:
+        type: string
+        description: "The version to delete"
+        required: true
+
+jobs:
+  delete-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout .github repo
+        uses: actions/checkout@master
+        with:
+          repository: rokucommunity/workflows
+
+      - name: Setup node
+        uses: actions/setup-node@master
+        with:
+          node-version: "16.20.2"
+
+      - name: Run npm ci
+        run: npm ci
+
+      - name: Delete release
+        env:
+           GH_TOKEN: ${{ github.token }}
+        run: |
+          npx ts-node src/cli.ts \
+            delete-release \
+            --projectName "${{ github.repository }}" \
+            --releaseVersion ${{ inputs.version }}

package/nested-ci/.github/workflows/initialize-release.yml

@@ -0,0 +1,63 @@
+name: Initialize Release
+
+on:
+  workflow_call:
+    inputs:
+      branch:
+        type: string
+        description: "The branch to create the release from"
+        default: "master"
+        required: true
+      releaseType:
+        type: string
+        description: "The type of release: major, minor, or patch"
+        required: true
+      installDependencies:
+        type: string
+        description: "Update dependencies"
+        required: true
+        default: 'true'
+
+jobs:
+  initialize-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout .github repo
+        uses: actions/checkout@master
+        with:
+          repository: rokucommunity/workflows
+
+      - name: Setup node
+        uses: actions/setup-node@master
+        with:
+          node-version: '16.20.2'
+
+      - name: Run npm ci
+        run: npm ci
+
+      - name: get RokuCommunity bot token #so the bot's name shows up on all our actions
+        uses: tibdex/github-app-token@v1
+        id: generate-token
+        with:
+          app_id: ${{ secrets.BOT_APP_ID }}
+          private_key: ${{ secrets.BOT_PRIVATE_KEY }}`
+
+      - name: Set RUNNER_DEBUG env variable
+        run: |
+          if [[ "$RUNNER_DEBUG" == "1" ]]; then
+            echo "RUNNER_DEBUG=true" >> $GITHUB_ENV
+          else
+            echo "RUNNER_DEBUG=false" >> $GITHUB_ENV
+          fi
+
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ steps.generate-token.outputs.token }}
+          DEBUG_LOGGING: ${{ env.RUNNER_DEBUG }}
+        run: |
+          npx ts-node src/cli.ts \
+            initialize-release \
+            --projectName "${{ github.repository }}" \
+            --releaseType "${{ inputs.releaseType }}" \
+            --branch "${{ inputs.branch }}" \
+            --installDependencies "${{ inputs.installDependencies == 'true' }}"

package/nested-ci/.github/workflows/make-release-artifacts.yml

@@ -0,0 +1,71 @@
+name: Make Release Artifacts
+
+on:
+   workflow_call:
+    inputs:
+        branch:
+            type: string
+            description: "The branch to create the release from"
+            required: true
+        node-version:
+            type: string
+            description: "The node version to use"
+            required: true
+        artifact-paths:
+            type: string
+            description: "The glob patters to find the release artifacts"
+            required: true
+
+jobs:
+  create-release-artifacts:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout caller repo
+        uses: actions/checkout@master
+        with:
+          ref: ${{ inputs.branch }}
+
+      - name: Checkout .github repo
+        uses: actions/checkout@master
+        with:
+          repository: rokucommunity/workflows
+          path: nested-ci
+
+      - name: Setup node
+        uses: actions/setup-node@master
+        with:
+          node-version: ${{ inputs.node-version }}
+
+      - name: run npm ci
+        run: npm ci
+
+      - name: Run package
+        run: npm run package;
+
+      - name: Setup node
+        uses: actions/setup-node@master
+        with:
+          node-version: "16.20.2"
+
+      - name: CD into nested-ci, run npm ci
+        run: |
+          cd nested-ci
+          npm ci
+
+      - name: Set RUNNER_DEBUG env variable
+        run: |
+          if [[ "$RUNNER_DEBUG" == "1" ]]; then
+            echo "RUNNER_DEBUG=true" >> $GITHUB_ENV
+          else
+            echo "RUNNER_DEBUG=false" >> $GITHUB_ENV
+          fi
+
+      - name: Run upload
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          npx ts-node nested-ci/src/cli.ts \
+            make-release-artifacts \
+            --branch "${{ inputs.branch }}" \
+            --projectName "${{ github.repository }}" \
+            --artifactPaths ${{ inputs.artifact-paths }}

package/nested-ci/.github/workflows/publish-release.yml

@@ -0,0 +1,50 @@
+name: Publish Release
+
+on:
+   workflow_call:
+    inputs:
+        ref:
+            type: string
+            description: "The merge commit created when the pull request is merged"
+            required: true
+        release-type:
+            type: string
+            description: "The type of release. Can be 'npm` or 'vsce'"
+            required: true
+
+jobs:
+  publish-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout .github repo
+        uses: actions/checkout@master
+        with:
+          repository: rokucommunity/workflows
+
+      - name: Setup node
+        uses: actions/setup-node@master
+        with:
+          node-version: "16.20.2"
+
+      - name: Run npm ci
+        run: npm ci
+
+      - name: Set RUNNER_DEBUG env variable
+        run: |
+          if [[ "$RUNNER_DEBUG" == "1" ]]; then
+            echo "RUNNER_DEBUG=true" >> $GITHUB_ENV
+          else
+            echo "RUNNER_DEBUG=false" >> $GITHUB_ENV
+          fi
+    
+      - name: Run publish
+        env:
+          GH_TOKEN: ${{ github.token }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          VSCE_TOKEN: ${{ secrets.VSCE_TOKEN }}
+        run: |
+          npx ts-node src/cli.ts \
+            publish-release \
+            --projectName "${{ github.repository }}" \
+            --ref ${{ inputs.ref }} \
+            --releaseType ${{ inputs.release-type }}

package/nested-ci/.github/workflows/tmpl-delete-release.yml

@@ -0,0 +1,16 @@
+name: Delete Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        type: string
+        description: "The version to delete"
+        required: true
+
+jobs:
+  run:
+    uses: rokucommunity/workflows/.github/workflows/delete-release.yml@master
+    with:
+      version: ${{ github.event.inputs.version }}
+    secrets: inherit

package/nested-ci/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+
+## [1.0.7](https://github.com/rokucommunity/.github/compare/v1.0.1...v1.0.7) - 2025-03-12
+### Changed
+ - Increment version to 1.0.1 ([98ba3ee](https://github.com/rokucommunity/.github/commit/98ba3ee))

package/nested-ci/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 RokuCommunity
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/nested-ci/README.md

@@ -0,0 +1,157 @@
+# Release Workflow System
+
+This repository holds reusable and template workflows for the new release system.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Workflow Templates](#workflow-templates)
+- [Shared CI](#shared-ci)
+  - [Step 1: Initialize Release](#step-1-initialize-release)
+  - [Step 2: Create Release Artifacts](#step-2-create-release-artifacts)
+  - [Step 3: Publish Release](#step-3-publish-release)
+- [Repository Setup](#repository-setup)
+  - [Setting Up Template Workflows in a Repository](#setting-up-template-workflows-in-a-repository)
+- [Recovering from a Failed Release CI](#recovering-from-a-failed-release-ci)
+- [Command Line](#command-line)
+
+---
+
+## Overview
+
+The CI flow consists of three key steps: **[Initialize Release](#step-1-initialize-release), [Create Release Artifacts](#step-2-create-release-artifacts), and [Publish Release](#step-3-publish-release)**. These workflows ensure a structured process for versioning, creating artifacts, and publishing new releases.
+
+---
+
+## Workflow Templates
+
+Each workflow step has an associated **template** to set up workflow triggers and call the reusable workflows from the Shared CI.
+
+### Template Purposes:
+
+- Hook into repository workflow triggers.
+- Call reusable workflows in the Shared CI.
+- Standardize workflow execution across repositories.
+
+---
+
+## Shared CI
+
+### Step 1: Initialize Release
+
+- **Purpose**: Prepares a new release by incrementing the version and creating a release branch.
+- **Triggers**: Manual dispatch with required parameters.
+- **Actions**:
+  1. Increment the version number.
+  2. Create and checkout a new branch (`release/version`).
+  3. Commit the updated version number.
+  4. Update and commit the changelog.
+  5. Open a draft GitHub release.
+  6. Create a pull request for review. _Note, this new pull request will trigger the next step._
+- **Required Parameters**:
+  - `branch` (target branch for the release)
+  - `release_type` (e.g., major, minor, patch)
+- [Initialize Release Template](https://github.com/rokucommunity/.github/blob/master/workflow-templates/initialize-release.yml)
+
+### Step 2: Create Release Artifacts
+
+- **Purpose**: Creates the release artifacts, and upload them.
+- **Triggers**: Pushes and updates to `release/*` branches.
+- **Actions**:
+    1. Build the release artifacts.
+    2. Upload artifacts to the draft GitHub release.
+- **Required Parameters** _(these are hardcoded in the template)_:
+  - `branch` (The head ref for the release PR)
+  - `node-version` (The node version used to build the artifacts)
+  - `asset-paths` (The glob path used to get all the release artifacts)
+- [Create Release Artifacts Release Template](https://github.com/rokucommunity/.github/blob/master/workflow-templates/create-release-artifacts.yml)
+### Step 3: Publish Release
+
+
+- **Purpose**: Finalizes the release by marking it as non-draft and publishing the code.
+- **Triggers**: Merging of a `release/*` branch.
+- **Actions**:
+  1. Mark the GitHub release as non-draft.
+  2. Publish the release to users (e.g., npm, VS Code Marketplace).
+- [Publish Release Template](https://github.com/rokucommunity/.github/blob/master/workflow-templates/publish-release.yml)
+- **Required Parameters** _(these are hardcoded in the template)_:
+  - `branch` (The head ref for the release PR)
+  - `release-store` (The head ref for the release PR)
+
+---
+
+## Repository Setup
+
+To integrate this release workflow system into a new repository, follow these steps:
+
+1. **Add Workflow Templates**: Each repository must include the workflow templates: `initialize-release`, `create-release-artifacts`, `publish-release` from this repository. More details in this section: [Setting Up Template Workflows in a Repository](#setting-up-template-workflows-in-a-repository)
+
+     [_Example repository workflow setup_](https://github.com/rokucommunity/release-testing/tree/master/.github/workflows)
+
+2. **Ensure Required NPM Script Exist**:
+   - `package`: Compiles the application.
+
+   _Example `package.json`_
+   ```json
+    "scripts": {
+      "package": "echo \"Place holder for build command\" && mkdir out && echo \"Hello World!\" > hello.txt"
+    },
+   ```
+3. **Build Artifacts Paths**:
+   - The `package` script name and place all artifacts in a way that the `asset_paths` set in [Create Release Artifacts Release Template](https://github.com/rokucommunity/.github/blob/master/workflow-templates/create-release-artifacts.yml) is selectable.
+   - The post-build step will look for release artifacts in this directory to upload to the GitHub release.
+
+---
+### Setting Up Template Workflows in a Repository  
+
+To integrate the release workflow system into a repository, follow these steps to add the required workflow templates from the **RokuCommunity** organization:  
+
+### Step 1: Add Workflow Templates  
+1. Navigate to your repository on GitHub.  
+2. Click on the **Actions** tab.  
+3. Click **New workflow** or go directly to `.github/workflows`.  
+4. Under **"Choose a workflow"**, find the **By RokuCommunity** templates:  
+   - **Initialize Release**  
+   - **Create Release Artifacts**  
+   - **Publish Release**  
+5. Click on each template and select **"Configure"**.  
+
+### Step 2: Check needed edits
+1. Edit `asset_paths` if needed
+2. Edit `node-version` if needed
+2. Edit `publish-store` if needed
+
+### Step 3: Commit the Workflow Files
+1. Click **Commit changes...**.  
+2. Ensure the commit is made to the default branch (master)
+5. Click **Commit changes**
+
+Once these workflows are set up, your repository will automatically follow the structured release process!
+
+---
+## Recovering from a Failed Release CI
+
+If the release CI fails and does not recover automatically, follow these steps to reset the release process:
+
+1. **Delete the GitHub Release**
+   - Go to the **Releases** section of your repository.
+   - Find the failed release.
+   - Click **Delete release**.
+
+2. **Delete the Pull Request for the Release**
+   - Navigate to the **Pull Requests** tab.
+   - Locate the pull request associated with the release.
+   - Close and delete the pull request.
+
+3. **Delete the Release Branch**
+   - Go to the **Branches** section of your repository.
+   - Find the branch created for the release (e.g., `release/version`).
+   - Delete the branch.
+
+_Note there is a [workflow template: Delete Release](https://github.com/rokucommunity/.github/blob/master/workflow-templates/delete-release.yml) that does all three steps_
+
+---
+## Command Line
+
+How would the command line work in each repository? The repos won't have the Reusable CI scripts.
+