Skip to content

[BFP-1052] Adds npm publish workflow #5

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.

Sign up for GitHub

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

Merged
alawrenc merged 9 commits into from
Feb 20, 2025
Merged

[BFP-1052] Adds npm publish workflow #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
27ad8e2
Adds npm publish workflow
shahzaib-sheikh Feb 12, 2025
42adede
Merge branch 'main' of github.com:fireflyprotocol/pro-sdk into shahza…
shahzaib-sheikh Feb 19, 2025
4750998
Fixed org name and removed debug logs
shahzaib-sheikh Feb 19, 2025
b773e94
Fixes registry config
shahzaib-sheikh Feb 19, 2025
9eef1fc
Added publish config
shahzaib-sheikh Feb 19, 2025
c3ca23a
Fixed name
shahzaib-sheikh Feb 19, 2025
0170c77
Removed temporary trigger
shahzaib-sheikh Feb 19, 2025
8b4b663
Merge branch 'main' into shahzaib/bfp-1052-publish-pro-sdk-package-to…
nikita-seedlabs Feb 20, 2025
ef8a736
Update ts/sdk/package.json
nikita-seedlabs Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/npm_publish.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: NPM Release

on:
push:
tags:
- ts-release-*

jobs:
publish-ts:
runs-on: ubuntu-latest
defaults:
run:
working-directory: ts/sdk
steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
registry-url: "https://registry.npmjs.org"

- name: Install dependencies
run: yarn install --immutable

- name: Build
run: yarn build

- name: Publish to NPM
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
Copy link
Contributor

@alawrenc alawrenc Feb 19, 2025

Choose a reason for hiding this comment

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

Triple-checking since this is now a public repo: this won't expose the secret via github action logs or any other way?

Copy link
Contributor Author

@shahzaib-sheikh shahzaib-sheikh Feb 19, 2025

Choose a reason for hiding this comment

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

This secret is not printed in action logs. as seen here.
image

The public contributions would require approval from maintainers before it runs gh-actions. e.g. fireflyprotocol/bluefin-v2-client-ts#154
image

Forks won't have access to this, as mentioned here,
https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#using-secrets-in-a-workflow
image

13 changes: 6 additions & 7 deletions ts/sdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "@fireflyprotocol/bluefin-pro-sdk",
"name": "@bluefin-exchange/pro-sdk",
"version": "0.1.12",
"description": "OpenAPI client for @bluefin/bluefin-pro-sdk",
"description": "OpenAPI client for @bluefin-exchange/pro-sdk",
"author": "Bluefin",
"repository": {
"type": "git",
"url": "https://github.com/fireflyprotocol/bluefin-pro-sdk.git"
"url": "https://github.com/fireflyprotocol/pro-sdk.git"
},
"keywords": [
"@bluefin/bluefin-pro-sdk"
"@fireflyprotocol/pro-sdk"
],
"license": "Unlicense",
"main": "./dist/index.js",
Expand All @@ -34,7 +34,6 @@
".": "./src/index.ts"
},
"publishConfig": {
"registry": "https://npm.pkg.github.com"
"access": "public"
}
}

}