docs: add installation instructions for Forgejo registry and update package.json for publishing
This commit is contained in:
parent
0a86eb1dd9
commit
9d1721bc3a
3 changed files with 51 additions and 0 deletions
36
.forgejo/workflows/publish-forgejo-npm.yml
Normal file
36
.forgejo/workflows/publish-forgejo-npm.yml
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
name: Publish to Forgejo npm Registry
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: native
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.FORGEJO_NPM_TOKEN }}
|
||||
REGISTRY_URL: https://git.mizuki.guru/api/packages/imnyang/npm/
|
||||
SCOPE: imnyang
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: https://code.forgejo.org/actions/checkout@v4
|
||||
|
||||
- name: Configure npm auth for Forgejo registry
|
||||
run: |
|
||||
REGISTRY_HOST="${REGISTRY_URL#https://}"
|
||||
REGISTRY_HOST="${REGISTRY_HOST#http://}"
|
||||
{
|
||||
echo "@${SCOPE}:registry=${REGISTRY_URL}"
|
||||
echo "//${REGISTRY_HOST}:_authToken=${NODE_AUTH_TOKEN}"
|
||||
echo "always-auth=true"
|
||||
} > "$HOME/.npmrc"
|
||||
|
||||
- name: Install, build, and publish in Nix shell
|
||||
run: |
|
||||
nix shell nixpkgs#nodejs_24 nixpkgs#pnpm -c sh -lc '
|
||||
pnpm install --frozen-lockfile
|
||||
pnpm build
|
||||
pnpm publish --no-git-checks --registry "$REGISTRY_URL"
|
||||
'
|
||||
12
README.md
12
README.md
|
|
@ -18,6 +18,18 @@ pnpm add @imnyang/comcigan.ts # pnpm
|
|||
bun add @imnyang/comcigan.ts
|
||||
```
|
||||
|
||||
## Forgejo 레지스트리에서 설치하기
|
||||
|
||||
이 패키지를 Forgejo 레지스트리에서 설치할 때는 설치하는 프로젝트(consumer) 쪽 설정이 필요합니다.
|
||||
|
||||
프로젝트 루트의 `.npmrc`에 아래를 추가하세요.
|
||||
|
||||
```ini
|
||||
@imnyang:registry=https://git.mizuki.guru/api/packages/imnyang/npm/
|
||||
```
|
||||
|
||||
패키지가 비공식(private)인 경우에는 인증 토큰도 필요합니다.
|
||||
|
||||
## 사용 예시
|
||||
|
||||
```typescript
|
||||
|
|
|
|||
|
|
@ -24,6 +24,9 @@
|
|||
],
|
||||
"author": "imnyang <me@imnya.ng>",
|
||||
"license": "LGPL-3.0-or-later",
|
||||
"publishConfig": {
|
||||
"registry": "https://git.mizuki.guru/api/packages/imnyang/npm/"
|
||||
},
|
||||
"packageManager": "pnpm@10.28.0",
|
||||
"devDependencies": {
|
||||
"@biomejs/biome": "^1.9.4",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue