azu / npm-github-package-example

npm registry to GitHub Package Registry example.

npm-github-package-example[test]

npm registry to GitHub Package Registry example.

This repository test for GitHub Workflow.

Release Workflow

1. [Manual] Update Version: npm version {patch,minor,major}
2. [Manual] Push: git push
3. [CI] Publish to npm and Push a tag to GitHub

This Release flow is defined in .github/workflows/publish.yml

name: publish
env:
  CI: true
on:
  push:
    branches:
      - master
    tags:
      - "!*"
jobs:
  release:
    name: Setup
    runs-on: ubuntu-latest
    steps:
      - name: checkout
        uses: actions/checkout@v3
      - name: setup Node
        uses: actions/setup-node@v3
        with:
          node-version: 16
          registry-url: 'https://npm.pkg.github.com'
      - name: install
        run: npm install
      - name: test
        run: npm test
      # Publish to npm if this version is not published
      - name: Publish
        run: |
          npx can-npm-publish --yes --verbose && npm publish || echo "Does not publish"
        env:
          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      # Push tag to GitHub if the version's tag is not tagged
      - name: package-version-to-git-tag
        uses: pkgdeps/git-tag-action@v2
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          github_repo: ${{ github.repository }}
          version: ${{ env.PACKAGE_VERSION }}
          git_commit_sha: ${{ github.sha }}
          git_tag_prefix: "v"

Install

Install with npm:

npm install @azu/npm-github-package-example

Usage

import { hello } from "@azu/npm-github-package-example"
hello("john"); // => "Hello, john"

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

• github/azu
• twitter/azu_re

License

MIT © azu

npm-github-package-example's Issues

example

with v2.0.1, the build is failing when the tag already exists

I tried pkgdeps/[email protected] to fix the warning about node 12 in GitHub actions, but this version is failing the build when the tag already exists:

Run pkgdeps/[email protected]
  with:
    github_token: ***
    github_repo: nuclia/frontend
    version: 1.0.18
    git_commit_sha: b5560223b83316a37a56711910b8174a9dac890c
    git_tag_prefix: v
  env:
    APP_IMAGE_NAME: app
    MANAGER_IMAGE_NAME: manager
    CDN_STORAGE: ***
    CONTAINER_REGISTRY: eu.gcr.io/***
    NX_BASE: ***
    NX_HEAD: ***
    PACKAGE_VERSION: 1.0.18
Error: Reference already exists