最初のGithubパッケージを作成する
4070 ワード
Githubは、2012年5月19日から彼らのGithubパッケージ登録を導入しました.つまり、ソースコードの横にあるプライベートパッケージまたはパブリックパッケージを管理できます.
私がこの記事を書くとき、まだこの新しいサービスを試みるために、あなたはまだベータにサインアップしなければなりません.
ここでは、最初のGithubパッケージを作成するための手順を示します.
あなたのGitHubアカウントへのログイン
私はすでにtypescriptパッケージのスターターを作成しました.あなたはgithubからそれをクローン化することができます.
/パッケージパッケージスターター.ユーザー名をパッケージに置き換える必要があります.JSONがあなた自身のパッケージで働くとき.
アレックスのおかげで-私の同僚-リポジトリを追加することで、複数のパッケージを同じGithubリポジトリに公開する機能があります.
あなたのコードを準備した後.あなたのgithubレポにそれを押してください.あなたはgithubからレポを作成する必要があります.COM .
テストを実行する
その前に、作成する必要があります.NPMRCファイル
私がこの記事を書くとき、まだこの新しいサービスを試みるために、あなたはまだベータにサインアップしなければなりません.
ここでは、最初のGithubパッケージを作成するための手順を示します.
ステップ1 :パーソナルアクセストークンを作成する
あなたのGitHubアカウントへのログイン
ステップ2 : NPMにログインしてください。pkg。ギタブ.コム
dnguyen:~ dalenguyen$ npm login --registry=https://npm.pkg.github.com
Username: GitHub-username
Password: your-personal-access-token
Email: (this IS public) [email protected]
Logged in as dalenguyen on https://npm.pkg.github.com/.
ステップ3 :ソースコードの準備
私はすでにtypescriptパッケージのスターターを作成しました.あなたはgithubからそれをクローン化することができます.
git clone https://github.com/dalenguyen/typescript-package-starter.git
プロジェクトの構造を示します.dist
--index.js
src
--index.ts
test
--index.spec.ts
このパッケージには1つの簡単な関数しかありませんexport const helloWorld = () => 'Howdy!'
Githubパッケージの登録にパッケージを公開するには、PublishConfigを追加する必要があります.それ以外の場合は、パッケージをNPMパッケージレジストリに公開します.{
"name": "typescript-package-starter",
"version": "1.0.0",
"description": "TypeScript boilerplate for NPM or Github Packages",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
"test": "mocha --timeout 60000 --exit -r ts-node/register test/**/*.spec.ts",
"build": "tsc",
"deploy": "npm publish"
},
"author": "Dale Nguyen",
"license": "ISC",
"repository": {
"type": "git",
"url": "git+https://github.com/dalenguyen/typescript-package-starter.git"
},
.........................
"publishConfig": {
"registry": "https://npm.pkg.github.com/@dalenguyen"
}
}
これでパッケージ名が作成されます./パッケージパッケージスターター.ユーザー名をパッケージに置き換える必要があります.JSONがあなた自身のパッケージで働くとき.
アレックスのおかげで-私の同僚-リポジトリを追加することで、複数のパッケージを同じGithubリポジトリに公開する機能があります.
ステップ4:Githubレポにプロジェクトをプッシュ
あなたのコードを準備した後.あなたのgithubレポにそれを押してください.あなたはgithubからレポを作成する必要があります.COM .
git init
git add .
git commit -m "Create first github package"
git push origin master
ステップ6 :最初のGithubパッケージを公開する
テストを実行する
npm test
最初のGithubパッケージを配備するnpm run build && npm deploy
とボイルステップ7 :最初のGithubパッケージをインストールしてみましょう
その前に、作成する必要があります.NPMRCファイル
// .npmrc
@your-username:registry=https://npm.pkg.github.com
次に、パッケージをインストールしますdalenguyen$ npm i @dalenguyen/typescript-package-starter
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN [email protected] No repository field.
+ [email protected] (as @dalenguyen/typescript-package-starter)
added 1 package from 1 contributor and removed 6 packages in 2.375s
ステップ8 :新しいパッケージをテストします
// index.js
const starter = require('@dalenguyen/typescript-package-starter')
console.log(starter.helloWorld())
インデックスを実行します.jsファイルdalenguyen$ node index.js
Howdy!
最初にGithubパッケージを作成して公開する方法を知っています.次のポストでは、しようとします.Reference
この問題について(最初のGithubパッケージを作成する), 我々は、より多くの情報をここで見つけました https://dev.to/dalenguyen/create-your-first-github-package-564fテキストは自由に共有またはコピーできます。ただし、このドキュメントのURLは参考URLとして残しておいてください。
Collection and Share based on the CC Protocol