-
-
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.
- Loading branch information
1 parent
1c9a4cb
commit b6c98b0
Showing
19 changed files
with
259 additions
and
64 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
This file was deleted.
Oops, something went wrong.
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
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 |
---|---|---|
|
@@ -21,9 +21,23 @@ name: publish | |
|
||
# Workflow triggers: | ||
on: | ||
# Run workflow when a new tag is pushed to the repository: | ||
push: | ||
tags: v[0-9]+.[0-9]+.[0-9]+ | ||
# Allow the workflow to be manually run: | ||
workflow_dispatch: | ||
# Workflow inputs: | ||
inputs: | ||
version: | ||
description: 'Version Increment' | ||
type: choice | ||
default: 'none' | ||
options: | ||
- 'none' | ||
- 'major' | ||
- 'minor' | ||
- 'patch' | ||
- 'premajor' | ||
- 'preminor' | ||
- 'prepatch' | ||
- 'prerelease' | ||
|
||
# Workflow jobs: | ||
jobs: | ||
|
@@ -32,14 +46,15 @@ jobs: | |
publish: | ||
|
||
# Define display name: | ||
name: 'Publish to npm' | ||
name: 'Publish package to npm' | ||
|
||
# Define the type of virtual host machine on which to run the job: | ||
runs-on: ubuntu-latest | ||
|
||
# Define environment variables: | ||
env: | ||
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} | ||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
|
||
# Define the sequence of job steps... | ||
steps: | ||
|
@@ -55,6 +70,91 @@ jobs: | |
node-version: 16 | ||
timeout-minutes: 5 | ||
|
||
# Configure git: | ||
- name: 'Configure git' | ||
run: | | ||
git config --local user.email "[email protected]" | ||
git config --local user.name "stdlib-bot" | ||
# Increment package version (if requested): | ||
- name: 'Increment package version (if requested)' | ||
if: ${{ github.event.inputs.version != 'none' }} | ||
run: | | ||
# Save NPM_TOKEN to user's .npmrc: | ||
echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc | ||
# Increment package version: | ||
npm version ${{ github.event.inputs.version }} --no-git-tag-version | ||
# Define variable for new version: | ||
NEW_VERSION=$(node -p "require('./package.json').version") | ||
# Replace branch in README.md link definitions for badges with the new version: | ||
find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/branch([=:])[^ ]+/branch\1v${NEW_VERSION}/g" | ||
# Create a new commit and tag: | ||
git add package.json README.md | ||
git commit -m "Release v${NEW_VERSION}" | ||
git tag -a "v${NEW_VERSION}" -m "Release v${NEW_VERSION}" | ||
# Push changes to GitHub: | ||
SLUG=${{ github.repository }} | ||
git push "https://$GITHUB_ACTOR:[email protected]/$SLUG.git" --follow-tags | ||
# Remove CLI: | ||
- name: 'Remove CLI' | ||
if: ${{ github.ref == 'refs/heads/main' }} | ||
run: | | ||
# Exit if the package does not have a CLI: | ||
if ! grep -q '"bin":' package.json; then | ||
exit 0 | ||
fi | ||
rm -rf ./bin/cli | ||
rm -f test/test.cli.js | ||
rm -f etc/cli_opts.json | ||
rm -f docs/usage.txt | ||
# For all dependencies, check in all *.js files if they are still used; if not, remove them: | ||
jq -r '.dependencies | keys[]' ./package.json | while read -r dep; do | ||
dep=$(echo "$dep" | xargs) | ||
if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then | ||
jq --indent 2 "del(.dependencies[\"$dep\"])" ./package.json > ./package.json.tmp | ||
mv ./package.json.tmp ./package.json | ||
fi | ||
done | ||
jq -r '.devDependencies | keys[]' ./package.json | while read -r dep; do | ||
if [[ "$dep" != "@stdlib"* ]]; then | ||
continue | ||
fi | ||
dep=$(echo "$dep" | xargs) | ||
if ! grep -q "$dep" lib/** && ! grep -q -s "$dep" manifest.json && ! grep -q -s "$dep" include.gypi; then | ||
jq --indent 2 "del(.devDependencies[\"$dep\"])" ./package.json > ./package.json.tmp | ||
mv ./package.json.tmp ./package.json | ||
fi | ||
done | ||
# Remove CLI section: | ||
find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?<section class=\"cli\">[\s\S]+?<\!\-\- \/.cli \-\->//" | ||
# Remove CLI from package.json: | ||
jq -r 'del(.bin)' package.json > package.json.tmp | ||
mv package.json.tmp package.json | ||
# Add entry for CLI package to See Also section of README.md: | ||
cliPkgName=$(jq -r '.name' package.json)-cli | ||
escapedPkg=$(echo "$cliPkgName" | sed -e 's/\//\\\//g') | ||
escapedPkg=$(echo "$escapedPkg" | sed -e 's/\@/\\\@/g') | ||
find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<section class=\"related\">(?:\n\n\* \* \*\n\n## See Also\n\n)?/<section class=\"related\">\n\n## See Also\n\n- <span class=\"package-name\">[\`$escapedPkg\`][$escapedPkg]<\/span><span class=\"delimiter\">: <\/span><span class=\"description\">CLI package for use as a command-line utility.<\/span>\n/" | ||
# Add link definition for CLI package to README.md: | ||
find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<section class=\"links\">/<section class=\"links\">\n\n[$escapedPkg]: https:\/\/www.npmjs.com\/package\/$escapedPkg/" | ||
# Replace GitHub MathJax equations with SVGs: | ||
- name: 'Replace GitHub MathJax equations with SVGs' | ||
run: | | ||
find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/```math\n([\s\S]+?)\n```\n\n//g' | ||
find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/<!-- <div class="equation"(.*)(<\/div>\s*-->)/<div class="equation"$1<\/div>/sg' | ||
# Replace GitHub links to individual packages with npm links: | ||
- name: 'Replace all GitHub links to individual packages with npm links' | ||
run: | | ||
|
@@ -65,14 +165,39 @@ jobs: | |
run: | | ||
find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`\n\nAlternatively,[^<]+<\/section>/\`\`\`\n\n<\/section>/" | ||
# Remove unnecessary files: | ||
- name: 'Remove unnecessary files' | ||
run: | | ||
rm -f docs/repl.txt | ||
rm -f docs/types/test.ts | ||
# Replace all stdlib GitHub dependencies with the respective npm packages: | ||
- name: 'Replace all stdlib GitHub dependencies with the respective npm packages' | ||
run: | | ||
find package.json -type f -print0 | xargs -0 sed -Ei 's/"github:stdlib-js[^"]*"/"^0.0.x"/g' | ||
for dep in $(jq -r '.dependencies | keys | .[]' package.json); do | ||
if [[ "$dep" != "@stdlib"* ]]; then | ||
continue | ||
fi | ||
# Trim leading and trailing whitespace: | ||
dep=$(echo "$dep" | xargs) | ||
version="^$(npm view $dep version)" | ||
jq -r --arg dep "$dep" --arg version "$version" '.dependencies[$dep] = $version' package.json > package.json.tmp | ||
mv package.json.tmp package.json | ||
done | ||
for dep in $(jq -r '.devDependencies | keys | .[]' package.json); do | ||
if [[ "$dep" != "@stdlib"* ]]; then | ||
continue | ||
fi | ||
# Trim leading and trailing whitespace: | ||
dep=$(echo "$dep" | xargs) | ||
version="^$(npm view $dep version)" | ||
jq -r --arg dep "$dep" --arg version "$version" '.devDependencies[$dep] = $version' package.json > package.json.tmp | ||
mv package.json.tmp package.json | ||
done | ||
# Publish package to npm: | ||
- name: 'Publish package to npm' | ||
uses: JS-DevTools/npm-publish@v1 | ||
uses: JS-DevTools/npm-publish@v2 | ||
with: | ||
token: ${{ secrets.NPM_TOKEN }} | ||
access: public | ||
|
@@ -84,7 +209,7 @@ jobs: | |
# Send status to Slack channel if job fails: | ||
- name: 'Send status to Slack channel in case of failure' | ||
uses: act10ns/slack@v1 | ||
uses: act10ns/slack@v2 | ||
with: | ||
status: ${{ job.status }} | ||
steps: ${{ toJson(steps) }} | ||
|
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
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
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
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
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
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,30 @@ | ||
cff-version: 1.2.0 | ||
title: stdlib | ||
message: >- | ||
If you use this software, please cite it using the | ||
metadata from this file. | ||
type: software | ||
|
||
authors: | ||
- name: The Stdlib Authors | ||
url: https://github.com/stdlib-js/stdlib/graphs/contributors | ||
|
||
repository-code: https://github.com/stdlib-js/stdlib | ||
url: https://stdlib.io | ||
|
||
abstract: | | ||
Standard library for JavaScript and Node.js. | ||
keywords: | ||
- JavaScript | ||
- Node.js | ||
- TypeScript | ||
- standard library | ||
- scientific computing | ||
- numerical computing | ||
- statistical computing | ||
|
||
license: Apache-2.0 AND BSL-1.0 | ||
|
||
date-released: 2016 |
Oops, something went wrong.