├── package.json-version ├── package.json ├── package.json-publishConfig-tag ├── package.json-publish ├── README.md ├── npm-publish-git └── LICENSE /package.json-version: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | var __cwd = process.cwd(); 4 | 5 | var pkg = require(__cwd + '/package.json'); 6 | console.log(pkg.version); 7 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "private": true, 3 | "name": "npm-publish-git", 4 | "version": "0.0.12", 5 | "license": "Apache-2.0", 6 | "bin": { 7 | "npm-publish-git": "./npm-publish-git" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /package.json-publishConfig-tag: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | var __cwd = process.cwd(); 4 | 5 | var pkg = require(__cwd + '/package.json'); 6 | if (!pkg.publishConfig || !pkg.publishConfig.tag) { 7 | return; 8 | } 9 | console.log(pkg.publishConfig.tag); 10 | -------------------------------------------------------------------------------- /package.json-publish: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | var __cwd = process.cwd(); 4 | 5 | var pkg = require(__cwd + '/package.json'); 6 | delete pkg.devDependencies; 7 | 8 | if (pkg.scripts) { 9 | delete pkg.scripts.prepare; 10 | } 11 | 12 | if (pkg.publishConfig) { 13 | pkg = Object.assign(pkg, pkg.publishConfig); 14 | delete pkg.publishConfig; 15 | } 16 | 17 | pkg = JSON.stringify(pkg, null, 2); 18 | console.log(pkg); 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # npm-publish-git 2 | 3 | Works, or should work, as `npm publish` does towards an npm registry, 4 | except the target is the git repository itself. 5 | 6 | 7 | ## Install 8 | 9 | ```shell 10 | npm install --save-dev git+https://github.com/andreineculau/npm-publish-git.git 11 | ``` 12 | 13 | ## Usage 14 | 15 | ```shell 16 | npm version patch 17 | # tag v1.0.1 created 18 | 19 | node_modules/.bin/npm-publish-git 20 | # tag v1.0.1-src created, pointing to the v1.0.1 commit above 21 | # tag v1.0.1 updated (=moved) to point to a commit that contains 22 | # only the artifacts sourced from the v1.0.1 commit above 23 | ``` 24 | 25 | Alternatively, you can publish to a tag of your choice, from any commit: 26 | 27 | ```shell 28 | node_modules/.bin/npm-publish-git --tag latest 29 | # tag latest created/updated to point to a commit that contains 30 | # only the artifacts sourced from the current commit 31 | ``` 32 | 33 | Now anyone that wants to use your package can turn their `package.json` into 34 | 35 | ```json 36 | { 37 | "...": "...", 38 | "dependencies": { 39 | "example1": "git+https://github.com/user/example1.git#semver:^1.2.3", 40 | "example2": "git+ssh://git@git.intra/example2.git#commitish" 41 | }, 42 | "...": "...", 43 | } 44 | ``` 45 | 46 | meaning they can install your package via 47 | `npm install git+https://github.com/user/example1.git#semver:^1.2.3`, etc. 48 | 49 | **NOTE** the `semver:` pattern is only available since npm@5 . 50 | 51 | 52 | ## Raison d'être 53 | 54 | In the world of binary artifacts, it may make sense to have a package manager. 55 | But in the world of text artifacts? 56 | 57 | Most of what gets published to NPM is not only just text, 58 | but probably more or less the same as the source. 59 | 60 | So with that in mind, why would you go through the trouble of: 61 | - creating an NPM account 62 | - publish artifacts on an NPM registry 63 | - maybe even set up a local/mirror NPM registry 64 | - give others in your team rights to publish updated artifacts 65 | - etc. etc. 66 | 67 | when you can leverage git dependencies in `package.json` 68 | and you don't need any of the above overhead? 69 | 70 | The only advantages of publishing to NPM are: 71 | - caching - [track issue](https://github.com/zkat/pacote/issues/94) 72 | - centralized uptime (read "if npm is down, the whole world is down, and everyone will work/wait for a fix"; 73 | it is obviously a disadvantage otherwise) 74 | - exposure 75 | - usage statistics 76 | - ? 77 | 78 | 79 | ## Comparison 80 | 81 | In my initial search, I did not find any previous implementations that serve the purpose, but there are. In retrospect, `npm-publish-git` is still superior in stability, parity with npm and simplicity (a bash script treating git and npm as blackboxes). Don't trust me, I'm biased, verify for yourself. 82 | 83 | * https://github.com/theoy/npm-git-publish (implemented via TypeScript, calling npm's JS APIs) 84 | * https://github.com/finom/deploy-to-git (not npm specific, pushes a folder to a git repository) 85 | * ? 86 | 87 | 88 | ## References 89 | 90 | * https://glebbahmutov.com/blog/use-github-instead-of-npm/ 91 | * ? 92 | 93 | 94 | ## License 95 | 96 | [Apache 2.0](LICENSE) 97 | -------------------------------------------------------------------------------- /npm-publish-git: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | 4 | #- npm-publish-git 1.0 5 | ## Usage: npm-publish-git [OPTION] 6 | ## Publish an NPM package to git tag. 7 | ## 8 | ## --tag TAG Use specific dist tag. "X.Y.Z" will be replaced with the current version 9 | ## 10 | ## -h, --help Display this help and exit 11 | ## -v, --version Output version information and exit 12 | 13 | [[ -f package.json ]] || { 14 | echo >&2 "package.json is missing." 15 | exit 1 16 | } 17 | 18 | [[ -z $(git status --porcelain) ]] || { 19 | echo >&2 "git status shows changed/untracked files." 20 | exit 1 21 | } 22 | 23 | # https://stackoverflow.com/a/246128/465684 24 | SOURCE=${BASH_SOURCE[0]} 25 | while [[ -h ${SOURCE} ]]; do # resolve $SOURCE until the file is no longer a symlink 26 | DIR=$(cd -P $(dirname ${SOURCE}) && pwd) 27 | SOURCE=$(readlink ${SOURCE}) 28 | [[ ${SOURCE} != /* ]] && SOURCE=${DIR}/${SOURCE} # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located 29 | done 30 | DIR=$(cd -P $(dirname ${SOURCE}) && pwd) 31 | 32 | COMMIT=$(git rev-parse --verify HEAD 2>/dev/null) 33 | VSN=$(${DIR}/package.json-version) 34 | VSN_TAG=v${VSN} 35 | VSN_SRC_TAG=${VSN_TAG} 36 | VSN_DIST_TAG=$(${DIR}/package.json-publishConfig-tag) 37 | CUSTOM_TAG=true 38 | 39 | [[ -n ${VSN_DIST_TAG} ]] || { 40 | VSN_DIST_TAG=${VSN_TAG} 41 | CUSTOM_TAG=false 42 | } 43 | 44 | while [[ $# -gt 0 ]]; do 45 | case "$1" in 46 | --tag) 47 | CUSTOM_TAG=true 48 | VSN_DIST_TAG="${2/X.Y.Z/${VSN}}" 49 | shift 2 50 | ;; 51 | -h|--help) 52 | grep "^##" "$0" | cut -c 4- 53 | exit 1 54 | ;; 55 | -v|--version) 56 | grep "^#-" "$0" | cut -c 4- 57 | exit 1 58 | ;; 59 | *) 60 | break 61 | ;; 62 | esac 63 | done 64 | 65 | [[ ${VSN_DIST_TAG} != ${VSN_TAG} ]] || 66 | VSN_SRC_TAG=${VSN_TAG}-src 67 | 68 | [[ ${CUSTOM_TAG} = true ]] || 69 | git tag --points-at ${COMMIT} | grep -q "^${VSN_TAG}$" || { 70 | echo >&2 "Current commit ${COMMIT} is not version tagged ${VSN_TAG}." 71 | exit 1 72 | } 73 | 74 | git ls-remote --exit-code --tags origin ${VSN_DIST_TAG} && { 75 | echo >&2 "There is already a published version of ${VSN_DIST_TAG}." 76 | exit 1 77 | } || true 78 | 79 | 80 | # git stash doesn't handle submodules 81 | tar -cf .git/npm-publish-git-stash.tar --exclude=./.git . 82 | 83 | function on_exit() { 84 | local ERR=$? 85 | 86 | git reset --hard ${COMMIT} >/dev/null 87 | git checkout . 88 | git clean -df 2>/dev/null 89 | tar -xf .git/npm-publish-git-stash.tar 90 | rm -f .git/npm-publish-git-stash.tar 91 | [[ ${ERR} != 0 ]] || 92 | exit ${ERR}; 93 | 94 | git tag -d ${VSN_SRC_TAG} >/dev/null || true 95 | git tag -d ${VSN_DIST_TAG} >/dev/null || true 96 | git tag -f ${VSN_TAG} >/dev/null || true 97 | exit ${ERR} 98 | } 99 | 100 | trap on_exit EXIT 101 | 102 | TARBALL=$(npm pack | tail -1) 103 | ${DIR}/package.json-publish > published.package.json 104 | 105 | ls -A | grep -v -e "^${TARBALL}\$" -e "^.git$" -e "^published.package.json$" | xargs rm -rf 106 | tar -xf ${TARBALL} 107 | ls -A package | xargs -I {} mv package/{} ./ 108 | 109 | rm -rf ${TARBALL} package 110 | mv {published.,}package.json 111 | 112 | [[ ${VSN_DIST_TAG} != ${VSN_TAG} ]] || 113 | git tag -f ${VSN_SRC_TAG} ${VSN_TAG} >/dev/null 114 | git add -Af 115 | COMMIT_MSG="${VSN} (dist)" 116 | [[ ${CUSTOM_TAG} = false ]] || COMMIT_MSG="${VSN} (${COMMIT})" 117 | git commit -q --allow-empty -m "${COMMIT_MSG}" 118 | git tag -f ${VSN_DIST_TAG} >/dev/null 119 | 120 | echo "Published ${VSN}" 121 | echo " as $(git rev-parse --verify HEAD 2>/dev/null) (${VSN_DIST_TAG})" 122 | echo " based on ${COMMIT} (${VSN_SRC_TAG})" 123 | 124 | git ls-tree --name-only --full-tree -r ${VSN_DIST_TAG} 125 | 126 | PUSH_TAGS=${VSN_DIST_TAG}:refs/tags/${VSN_DIST_TAG} 127 | [[ ${VSN_DIST_TAG} != ${VSN_TAG} ]] || 128 | PUSH_TAGS="${PUSH_TAGS} ${VSN_SRC_TAG}:refs/tags/${VSN_SRC_TAG}" 129 | git push --no-verify -f origin ${PUSH_TAGS} 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | --------------------------------------------------------------------------------