Skip to content

standalone_publish #158

standalone_publish

standalone_publish #158

#/
# @license Apache-2.0
#
# Copyright (c) 2021 The Stdlib Authors.
#
# 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.
#/
# Workflow name:
name: standalone_publish
# Workflow triggers:
on:
# Allow the workflow to be manually run:
workflow_dispatch:
inputs:
release-type:
type: choice
description: 'Type of release to create'
default: 'none'
options:
- none
- patch
- minor
- major
- auto
dry-run:
type: boolean
description: 'Skip uploading packages (dry run):'
default: false
start-index:
type: number
description: 'Index of first package to publish'
default: 0
end-index:
type: number
description: 'Index of last package to publish'
default: 9999
# Workflow concurrency group:
concurrency:
# Specify a group name:
group: ${{ github.workflow }}
# Specify whether to cancel any currently running workflow in the same concurrency group:
cancel-in-progress: false
# Global permissions:
permissions:
# Allow read-only access to the repository contents:
contents: read
# Workflow jobs:
jobs:
# Define a job for publishing standalone packages...
publish:
# Define a display name:
name: 'Publish'
# Define the type of virtual host machine:
runs-on: ubuntu-latest
# Define the sequence of job steps...
steps:
# Checkout the repository:
- name: 'Checkout repository'
# Pin action to full length commit SHA
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
# Specify whether to remove untracked files before checking out the repository:
clean: false
# Fetch all history to allow for changelog generation:
fetch-depth: 0
# Specify whether to download Git-LFS files:
lfs: false
timeout-minutes: 10
# Configure Git:
- name: 'Configure Git'
run: |
git config --local user.email "82920195+stdlib-bot@users.noreply.github.com"
git config --local user.name "stdlib-bot"
# Apply Git notes:
- name: 'Apply Git notes'
run: |
make apply-git-notes
# Install Node.js:
- name: 'Install Node.js'
# Pin action to full length commit SHA
uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
with:
node-version: '20' # 'lts/*'
timeout-minutes: 5
# Install dependencies (accounting for possible network failures, etc, when installing node module dependencies):
- name: 'Install dependencies'
run: |
make install-node-modules || make install-node-modules || make install-node-modules
timeout-minutes: 15
# Publish standalone packages:
- name: 'Publish packages'
env:
GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
# Save NPM_TOKEN to user's .npmrc:
echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
node lib/node_modules/@stdlib/_tools/scripts/publish_packages.js --skip-toplevel --release-type=${{ github.event.inputs.release-type }} --start-index=${{ github.event.inputs.start-index }} --end-index=${{ github.event.inputs.end-index }} ${{ github.event.inputs.dry-run == 'true' && '--skip-upload ' || '' }}
# Archive list of to be published packages:
- name: 'Archive package list'
# Pin action to full length commit SHA
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: ordered-pkg-list
path: |
/tmp/stdlib_ordered_pkg_list.json
/tmp/stdlib_published_pkg_list.json
# Define a job for sending notifications to Zulip...
zulip:
# Define a display name:
name: 'Zulip notification'
# Define the type of virtual host machine:
runs-on: 'ubuntu-latest'
# Indicate that this job depends on the prior job finishing:
needs: publish
# Run this job regardless of the outcome of the prior job:
if: always()
# Set defaults:
defaults:
run:
# Set the default shell to `bash`:
shell: bash --noprofile --norc -eo pipefail {0}
# Define the sequence of job steps...
steps:
# Resolve notification data:
- name: 'Resolve notification data'
run: |
if [[ "${{ needs.publish.result }}" = "success" ]]; then
echo 'NOTIFICATION_ICON=:check:' >> $GITHUB_ENV
echo 'NOTIFICATION_STATUS=succeeded' >> $GITHUB_ENV
elif [[ "${{ needs.publish.result }}" = "failure" ]]; then
echo 'NOTIFICATION_ICON=:cross_mark:' >> $GITHUB_ENV
echo 'NOTIFICATION_STATUS=failed' >> $GITHUB_ENV
elif [[ "${{ needs.publish.result }}" = "cancelled" ]]; then
echo 'NOTIFICATION_ICON=:warning:' >> $GITHUB_ENV
echo 'NOTIFICATION_STATUS=was canceled' >> $GITHUB_ENV
else
exit 1
fi
timeout-minutes: 5
# Send notification to Zulip:
- name: 'Send notification'
# Pin action to full length commit SHA
uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2
if: success()
with:
api-key: ${{ secrets.ZULIP_API_KEY }}
email: 'github-actions-bot@stdlib.zulipchat.com'
organization-url: 'https://stdlib.zulipchat.com'
to: 'workflows'
type: 'stream'
topic: 'standalone-publish'
content: |
${{ env.NOTIFICATION_ICON }} **standalone_publish** workflow ${{ env.NOTIFICATION_STATUS }}
**Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})
timeout-minutes: 5