2.3.2 • Published 4 years ago
@azu/npm-github-package-example v2.3.2
npm-github-package-example
npm registry to GitHub Package Registry example.
This repository test for GitHub Workflow.
Release Workflow
- Manual Update Version:
npm vession {patch,minor,major}
- Manual Push:
git push
- 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@v1
- name: setup Node
uses: actions/setup-node@v1
with:
node-version: 12.x
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 --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: azu/action-package-version-to-git-tag@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
github_repo: ${{ github.repository }}
git_commit_sha: ${{ github.sha }}
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.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
License
MIT © azu
2.3.2
4 years ago