Skip to content

Commit

Permalink
build: update to public package
Browse files Browse the repository at this point in the history
  • Loading branch information
robdmoore committed Jan 29, 2024
1 parent bce79f3 commit 2911942
Show file tree
Hide file tree
Showing 7 changed files with 147 additions and 194 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
registry-url: 'https://npm.pkg.github.com'
scope: '@makerxstudio'
cache: 'npm'
cache-dependency-path: ./package-lock.json

Expand Down
5 changes: 1 addition & 4 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ jobs:
uses: actions/setup-node@v3
with:
node-version: lts/*
registry-url: 'https://npm.pkg.github.com'
scope: '@makerxstudio'

# run npm ci preventing script access to npm auth token
- run: npm ci --ignore-scripts
Expand All @@ -46,6 +44,5 @@ jobs:
- name: Release package
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,8 @@

## Install

Ensure you are authenticated to the [GitHub package repository with your PAT](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token) and add an `.npmrc` with the below contents:

```
@makerxstudio:registry=https://npm.pkg.github.com
```

```bash
npm install @makerxstudio/node-ipfs
npm install @makerx/node-ipfs
```

> [!NOTE]
Expand All @@ -27,8 +21,8 @@ The primary purpose of this package is to make reading and writing files on the

```typescript
import { S3 } from '@aws-sdk/client-s3'
import { PinataStorageWithCache } from '@makerxstudio/node-ipfs'
import { S3ObjectCache } from '@makerxstudio/node-cache'
import { PinataStorageWithCache } from '@makerx/node-ipfs'
import { S3ObjectCache } from '@makerx/node-cache'

const s3Cache = new S3ObjectCache(
new S3({
Expand Down
Loading

0 comments on commit 2911942

Please sign in to comment.