clean it all up

Author: jsjoeio

.github/workflows/ci.yaml

@@ -191,13 +191,13 @@ jobs:
       - name: Run ./ci/steps/publish-npm.sh
         run: yarn publish:npm
         env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           # The way this logic works is it checks if the GitHub event is a push to the `main` branch
           # if so, we're in the staging environment (i.e. running in CI on merge into `main`)
           # otherwise it's running in CI on a PR event, meaning development environment
           # Source: https://kevsoft.net/2020/06/10/running-github-action-steps-and-jobs-only-on-push-to-master.html
           ENVIRONMENT: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && 'staging' || 'development' }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
   # TODO: cache building yarn --production
   # possibly 2m30s of savings(?)

.github/workflows/npm-brew.yaml

@@ -19,9 +19,9 @@ jobs:
       - name: Publish npm package and tag with "latest"
         run: yarn publish:npm
         env:
-          ENVIRONMENT: "production"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_ENVIRONMENT: "production"
 
   homebrew:
     # The newest version of code-server needs to be available on npm when this runs

ci/build/release-github-assets.sh

@@ -10,7 +10,7 @@ main() {
   cd "$(dirname "$0")/../.."
   source ./ci/lib.sh
 
-  download_artifact release-packages ./release-packages
+  download_artifact release-packages ./release-packages "production" "v$VERSION"
   local assets=(./release-packages/code-server*"$VERSION"*{.tar.gz,.deb,.rpm})
 
   EDITOR=true gh release upload "v$VERSION" "${assets[@]}" --clobber

ci/lib.sh

@@ -61,41 +61,38 @@ arch() {
 # https://developer.github.com/v3/actions/workflow-runs/#list-workflow-runs
 get_artifacts_url() {
   local environment="$1"
+  local branch="$2"
   local artifacts_url
+  local event
 
   case $environment in
     production)
       # This assumes you're releasing code-server using a branch named `v$VERSION` i.e. `v4.0.1`
       # If you don't, this will fail.
-      local branch="v$VERSION"
-      local event="pull_request"
-      local workflow_runs_url="repos/:owner/:repo/actions/workflows/ci.yaml/runs?event=$event&branch=$branch"
-      artifacts_url=$(gh api "$workflow_runs_url" | jq -r ".workflow_runs[] | select(.head_branch == \"$branch\") | .artifacts_url" | head -n 1)
+      branch="v$VERSION"
+      event="pull_request"
       ;;
     staging)
-      local branch="main"
-      local event="push"
-      local workflow_runs_url="repos/:owner/:repo/actions/workflows/ci.yaml/runs?event=$event&branch=$branch"
-      artifacts_url=$(gh api "$workflow_runs_url" | jq -r ".workflow_runs[] | select(.head_branch == \"$branch\") | .artifacts_url" | head -n 1)
+      branch="main"
+      event="push"
       ;;
     development)
-      # TODO@jsjoeio how do we get the branch name here? probably need to pass in from caller
-      local branch="????"
-      local event="pull_request"
-      local workflow_runs_url="repos/:owner/:repo/actions/workflows/ci.yaml/runs?event=$event&branch=$branch"
-      artifacts_url=$(gh api "$workflow_runs_url" | jq -r ".workflow_runs[] | select(.head_branch == \"$version_branch\") | .artifacts_url" | head -n 1)
+      # Use $branch value passed in in this case
+      event="pull_request"
       ;;
     *)
-      echo -n "unknown"
+      # Assume production for default
+      branch="v$VERSION"
+      event="pull_request"
       ;;
   esac
 
-  local workflow_runs_url="repos/:owner/:repo/actions/workflows/ci.yaml/runs?event=pull_request&branch=$version_branch"
-  artifacts_url=$(gh api "$workflow_runs_url" | jq -r ".workflow_runs[] | select(.head_branch == \"$version_branch\") | .artifacts_url" | head -n 1)
+  local workflow_runs_url="repos/:owner/:repo/actions/workflows/ci.yaml/runs?event=$event&branch=$branch"
+  artifacts_url=$(gh api "$workflow_runs_url" | jq -r ".workflow_runs[] | select(.head_branch == \"$branch\") | .artifacts_url" | head -n 1)
 
   if [[ -z "$artifacts_url" ]]; then
     echo >&2 "ERROR: artifacts_url came back empty"
-    echo >&2 "We looked for a successful run triggered by a pull_request with for code-server version: $VERSION and a branch named $version_branch"
+    echo >&2 "We looked for a successful run triggered by a pull_request with for code-server version: $VERSION and a branch named $branch"
     echo >&2 "URL used for gh API call: $workflow_runs_url"
     exit 1
   fi
@@ -107,27 +104,32 @@ get_artifacts_url() {
 # Takes 2 arguments:
 # $1 = artifact_name {string} - the name of the artifact to download (i.e. "npm-package")
 # $2 = environment {string} "staging" | "development" | "production" - which environment this is called in
+# $3 = branch {string} - the branch name
 # See: https://developer.github.com/v3/actions/artifacts/#list-workflow-run-artifacts
 get_artifact_url() {
   local artifact_name="$1"
   local environment="$2"
-  gh api "$(get_artifacts_url "$environment")" | jq -r ".artifacts[] | select(.name == \"$artifact_name\") | .archive_download_url" | head -n 1
+  local branch="$3"
+  gh api "$(get_artifacts_url "$environment" "$branch")" | jq -r ".artifacts[] | select(.name == \"$artifact_name\") | .archive_download_url" | head -n 1
 }
 
 # A helper function to download the an artifact into a directory
 # Takes 3 arguments:
 # $1 = artifact_name {string} - the name of the artifact to download (i.e. "npm-package")
 # $2 = destination {string} - where to download the artifact
 # $3 = environment {string} "staging" | "development" | "production" - which environment this is called in
+# $4 = branch {string} - the name of the branch to use when looking for artifacts
 download_artifact() {
   local artifact_name="$1"
   local dst="$2"
-  local environment="$3"
+  # We assume production values unless specified
+  local environment="${3:-production}"
+  local branch="${4:v$VERSION}"
 
   local tmp_file
   tmp_file="$(mktemp)"
 
-  gh api "$(get_artifact_url "$artifact_name" "$environment")" > "$tmp_file"
+  gh api "$(get_artifact_url "$artifact_name" "$environment" "$branch")" > "$tmp_file"
   unzip -q -o "$tmp_file" -d "$dst"
   rm "$tmp_file"
 }

ci/steps/docker-buildx-push.sh

@@ -24,7 +24,7 @@ main() {
   fi
 
   # Download the release-packages artifact
-  download_artifact release-packages ./release-packages
+  download_artifact release-packages ./release-packages "production" "v$VERSION"
 
   # Login to Docker
   if [[ ${CI-} ]]; then

ci/steps/publish-npm.sh

@@ -30,8 +30,8 @@ main() {
   # a developer to install this version with `yarn add code-server@beta`
   # "production" - this means we tag with `latest` (default), allowing
   # a developer to install this version with `yarn add code-server@latest`
-  if ! is_env_var_set "ENVIRONMENT"; then
-    echo "ENVIRONMENT is not set. Cannot determine npm tag without ENVIRONMENT."
+  if ! is_env_var_set "NPM_ENVIRONMENT"; then
+    echo "NPM_ENVIRONMENT is not set. Cannot determine npm tag without NPM_ENVIRONMENT."
     exit 1
   fi
 
@@ -53,6 +53,12 @@ main() {
     exit 1
   fi
 
+  # We use this to grab the branch name
+  if ! is_env_var_set "GITHUB_REF_NAME"; then
+    echo "GITHUB_REF_NAME is not set. Are you running this locally? We rely on values provided by GitHub."
+    exit 1
+  fi
+
   # We use this when setting NPM_VERSION
   if ! is_env_var_set "GITHUB_SHA"; then
     echo "GITHUB_SHA is not set. Are you running this locally? We rely on values provided by GitHub."
@@ -64,11 +70,12 @@ main() {
     echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
   fi
 
-  # TODO@jsjoeio we need to refactor to download this based on environment
-  # for "development", use the branch artifacts
-  # for "staging" (merges into main),
-  # for "production" look for release branch (currently we do this)
-  download_artifact npm-package ./release-npm-package
+  # Note: if this runs on a push to main or a release workflow
+  # There is no BRANCH so branch will be empty which is why
+  # we set a default.
+  # Source:https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+  BRANCH="${GITHUB_REF_NAME:main}"
+  download_artifact npm-package ./release-npm-package "$NPM_ENVIRONMENT" "$BRANCH"
   # https://github.com/actions/upload-artifact/issues/38
   tar -xzf release-npm-package/package.tar.gz
 
@@ -80,27 +87,27 @@ main() {
   # We only need to run npm version for "development" and "staging".
   # This is because our release:prep script automatically bumps the version
   # in the package.json and we commit it as part of the release PR.
-  if [[ "$ENVIRONMENT" == "production" ]]; then
+  if [[ "$NPM_ENVIRONMENT" == "production" ]]; then
     NPM_VERSION="$VERSION"
     # This means the npm version will be published as "stable"
     # and installed when a user runs `yarn install code-server`
     NPM_TAG="latest"
   else
     COMMIT_SHA="$GITHUB_SHA"
     echo "Not a production environment"
-    echo "Found environment: $ENVIRONMENT"
+    echo "Found environment: $NPM_ENVIRONMENT"
     echo "Manually bumping npm version..."
 
-    if [[ "$ENVIRONMENT" == "beta" ]]; then
+    if [[ "$NPM_ENVIRONMENT" == "beta" ]]; then
       NPM_VERSION="$VERSION-beta-$COMMIT_SHA"
       # This means the npm version will be tagged with "beta"
       # and installed when a user runs `yarn install code-server@beta`
       NPM_TAG="beta"
     fi
 
-    if [[ "$ENVIRONMENT" == "development" ]]; then
+    if [[ "$NPM_ENVIRONMENT" == "development" ]]; then
       # Source: https://github.com/actions/checkout/issues/58#issuecomment-614041550
-      PR_NUMBER=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
+      PR_NUMBER=$(echo "$GITHUB_REF" | awk 'BEGIN { FS = "/" } ; { print $3 }')
       NPM_VERSION="$VERSION-$PR_NUMBER-$COMMIT_SHA"
       # This means the npm version will be tagged with "<pr number>"
       # and installed when a user runs `yarn install code-server@<pr number>`