Skip to content

Commit

Permalink
new license and updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kenotron committed Jun 25, 2019
1 parent f590605 commit b6b1a88
Show file tree
Hide file tree
Showing 17 changed files with 204 additions and 13 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

# Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Microsoft Corporation. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
39 changes: 39 additions & 0 deletions azure-pipelines.release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Node.js
# Build a general Node.js project with npm.
# Add steps that analyze code, save build artifacts, deploy, and more:
# https://docs.microsoft.com/azure/devops/pipelines/languages/javascript

pr: none

trigger:
- master

pool:
vmImage: 'Ubuntu-16.04'

steps:
- task: NodeTool@0
inputs:
versionSpec: '10.x'
displayName: 'Install Node.js'

- script: |
git config user.email "[email protected]"
git config user.name "[email protected]"
git remote set-url origin https://$(github.user):$(github.pat)@github.com/kenotron/beachball.git
displayName: 'git config'
- script: |
yarn
displayName: 'yarn'
- script: |
yarn checkchange
displayName: 'check change files'
- script: |
yarn build
displayName: 'build'
- script: |
yarn test
displayName: 'test'
- script: |
yarn publish:beachball -n $(npm.authtoken) -y
displayName: 'beachball publish'
4 changes: 3 additions & 1 deletion docs/bump/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@
}
}
})
</script><link rel="preconnect dns-prefetch" href="https://www.google-analytics.com"/><link rel="sitemap" type="application/xml" href="/beachball/sitemap.xml"/><link rel="manifest" href="/beachball/manifest.webmanifest"/><meta name="theme-color" content="#c62828"/><link rel="apple-touch-icon" sizes="192x192" href="/beachball/logos/logo-192x192.png"/><link rel="apple-touch-icon" sizes="512x512" href="/beachball/logos/logo-512x512.png"/><link as="script" rel="preload" href="/beachball/1-fb9cf07ce705d9413799.js"/><link as="script" rel="preload" href="/beachball/component---src-templates-doc-jsx-f2a82ec9b4273c559cca.js"/><link as="script" rel="preload" href="/beachball/app-69d1df5c4bd11cb50de3.js"/><link as="script" rel="preload" href="/beachball/styles-8df20b4e40fb1a09a321.js"/><link as="script" rel="preload" href="/beachball/webpack-runtime-23509fd1b32cfe95b828.js"/><link as="fetch" rel="preload" href="/beachball/page-data/bump/page-data.json" crossorigin="use-credentials"/><link rel="shortcut icon" href="/beachball/static/logo-48-498be729f92ecef0ba4ce56f04724541.png"/></head><body><div id="___gatsby"><div style="outline:none" tabindex="-1" role="group"><div><div><div class="doc__BodyGrid-sc-1ant3rg-0 dbvaCy"><div class="doc__HeaderContainer-sc-1ant3rg-2 fjDSUB"><div class="Header__SiteContainer-sc-12paipw-0 flqKQb"><div class="Navigation__NavContainer-sc-1v7bid7-0 cvmuke"><section><a class="nav-link" href="/beachball/"> <!-- -->HOME<!-- --> </a><a class="nav-link" href="/beachball/getting-started"> <!-- -->DOCS<!-- --> </a></section><span><div class="user-links UserLinks__Container-sc-1cfrp8c-0 jlZQnb"><a href="https://github.com/kenotron/beachball" class="UserLinks__UserIcon-sc-1cfrp8c-1 cMtBrL"><svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 480 512" style="width:20px;height:20px" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"></path></svg></a></div></span></div></div></div><div class="doc__ToCContainer-sc-1ant3rg-3 jHFMmv"><div class="TableOfContents__TOCWrapper-yx8s11-0 eZNofu"><ol class="TableOfContents__StyledChapterList-yx8s11-1 eeqRQl"><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><h5 class="TableOfContents__ChapterTitle-yx8s11-6 iXqcjv">Overview</h5></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><ol class="TableOfContents__StyledLinkList-yx8s11-2 bEvTyp"><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/getting-started"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">Getting Started</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/installation"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">Installation</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/change-files"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">Change Files</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/ci-integration"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">CI Integration</h6></a></li></ol></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"></li></ol><ol class="TableOfContents__StyledChapterList-yx8s11-1 eeqRQl"><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><h5 class="TableOfContents__ChapterTitle-yx8s11-6 iXqcjv">CLI Reference</h5></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><ol class="TableOfContents__StyledLinkList-yx8s11-2 bEvTyp"><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/change"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">change</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/check"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">check</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a aria-current="page" class="" href="/beachball/bump"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">bump</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/publish"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">publish</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/options"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">options</h6></a></li></ol></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"></li></ol></div></div><div class="doc__BodyContainer-sc-1ant3rg-1 dCzHbD"><div><h1>bump</h1><div><p>Bumps versions locally without publishing to the remote git repo or npm registry. This command will also generate changelogs. By using this command, it is up to you to synchronize the package versions in the remote git repo as well as the npm registry.</p></div></div></div></div></div></div></div></div><script>
</script><link rel="preconnect dns-prefetch" href="https://www.google-analytics.com"/><link rel="sitemap" type="application/xml" href="/beachball/sitemap.xml"/><link rel="manifest" href="/beachball/manifest.webmanifest"/><meta name="theme-color" content="#c62828"/><link rel="apple-touch-icon" sizes="192x192" href="/beachball/logos/logo-192x192.png"/><link rel="apple-touch-icon" sizes="512x512" href="/beachball/logos/logo-512x512.png"/><link as="script" rel="preload" href="/beachball/1-fb9cf07ce705d9413799.js"/><link as="script" rel="preload" href="/beachball/component---src-templates-doc-jsx-f2a82ec9b4273c559cca.js"/><link as="script" rel="preload" href="/beachball/app-69d1df5c4bd11cb50de3.js"/><link as="script" rel="preload" href="/beachball/styles-8df20b4e40fb1a09a321.js"/><link as="script" rel="preload" href="/beachball/webpack-runtime-23509fd1b32cfe95b828.js"/><link as="fetch" rel="preload" href="/beachball/page-data/bump/page-data.json" crossorigin="use-credentials"/><link rel="shortcut icon" href="/beachball/static/logo-48-498be729f92ecef0ba4ce56f04724541.png"/></head><body><div id="___gatsby"><div style="outline:none" tabindex="-1" role="group"><div><div><div class="doc__BodyGrid-sc-1ant3rg-0 dbvaCy"><div class="doc__HeaderContainer-sc-1ant3rg-2 fjDSUB"><div class="Header__SiteContainer-sc-12paipw-0 flqKQb"><div class="Navigation__NavContainer-sc-1v7bid7-0 cvmuke"><section><a class="nav-link" href="/beachball/"> <!-- -->HOME<!-- --> </a><a class="nav-link" href="/beachball/getting-started"> <!-- -->DOCS<!-- --> </a></section><span><div class="user-links UserLinks__Container-sc-1cfrp8c-0 jlZQnb"><a href="https://github.com/kenotron/beachball" class="UserLinks__UserIcon-sc-1cfrp8c-1 cMtBrL"><svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 480 512" style="width:20px;height:20px" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"></path></svg></a></div></span></div></div></div><div class="doc__ToCContainer-sc-1ant3rg-3 jHFMmv"><div class="TableOfContents__TOCWrapper-yx8s11-0 eZNofu"><ol class="TableOfContents__StyledChapterList-yx8s11-1 eeqRQl"><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><h5 class="TableOfContents__ChapterTitle-yx8s11-6 iXqcjv">Overview</h5></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><ol class="TableOfContents__StyledLinkList-yx8s11-2 bEvTyp"><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/getting-started"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">Getting Started</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/installation"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">Installation</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/change-files"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">Change Files</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/ci-integration"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">CI Integration</h6></a></li></ol></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"></li></ol><ol class="TableOfContents__StyledChapterList-yx8s11-1 eeqRQl"><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><h5 class="TableOfContents__ChapterTitle-yx8s11-6 iXqcjv">CLI Reference</h5></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"><ol class="TableOfContents__StyledLinkList-yx8s11-2 bEvTyp"><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/change"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">change</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/check"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">check</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a aria-current="page" class="" href="/beachball/bump"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">bump</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/publish"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">publish</h6></a></li><li class="TableOfContents__EntryListItem-yx8s11-5 eQzkyw"><a href="/beachball/options"><h6 class="TableOfContents__EntryTitle-yx8s11-3 cYztyS">options</h6></a></li></ol></li><li class="TableOfContents__ChapterListItem-yx8s11-4 jUYcww"></li></ol></div></div><div class="doc__BodyContainer-sc-1ant3rg-1 dCzHbD"><div><h1>bump</h1><div><p>Bumps versions locally without publishing to the remote git repo or npm registry. This command will also generate changelogs.</p>
<p>This is the same logic that is used by the publish command, so it is a good practice to bump things locally to see what kind of changes are going to be done before those changes are published to the npm registry and the remote git repo. Since this affects files locally only, it is up to you to synchronize the package versions in the remote git repo as well as the npm registry.</p>
<div class="gatsby-highlight" data-language="bash"><pre class="language-bash"><code class="language-bash">$ beachball bump</code></pre></div></div></div></div></div></div></div></div></div><script>


if(true) {
Expand Down
Loading

0 comments on commit b6b1a88

Please sign in to comment.