CI! (#82)

* Switching to namespaced package, github actions to create the repository

* bump

* no more release guard

* WIP

* try setting some node engine constraints

* WIP

* checking in

* WIP

* Release 0.1.2

* CI

* Release 0.1.3

* forget releases, it's about tags

* Release 0.1.4

* only version

* Release 0.1.5

* back to basics

* Release 0.1.6

* A wee bit more context

* ci builds lib

* Release 0.1.7

* downgrade the node version to ^18.13.0

* downgrade the node version to ^18.13.0

* Release 0.1.8

* readme updates

Co-authored-by: Alisha Evans <[email protected]>

Author: xrl

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on:
+  push:
+    tags: ["*"]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v3
+      # Setup .npmrc file to publish to GitHub Packages
+      - uses: actions/setup-node@v3
+        with:
+          registry-url: 'https://npm.pkg.github.com'
+          # Defaults to the user or organization that owns the workflow file
+          scope: '@octocat'
+          node-version-file: package.json
+      - run: npm ci
+      - run: npm run build-lib
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
 # dependencies
 node_modules
 dist
+yarn-error.log

.release-it.json

@@ -0,0 +1,5 @@
+{
+  "npm": {
+    "publish": false
+  }
+}

README.md

@@ -105,6 +105,20 @@ npm run build-lib # use when you want to build the library for publishing
 npm run watch-lib # use when you want to build the library for local use; it will watch for changes. it may take up to 30 seconds to reflect a change though
 ```
 
+## Cutting a New Release
+A git tag should exist for every release. We use `release-it` to automate the coordination of package.json and git tag.
+
+If you want to release a new semver release run:
+
+  npm run release
+  (You will be prompted to select a release type, e.g. patch)
+
+And be sure to say yes to all the prompts, you want a commit, you want a tag, and you want to push up to github.
+
+## Teaching Yarn How To Install This Library
+
+    yarn add @scientist-softserv/webstore-component-library@https://github.com/scientist-softserv/webstore-component-library
+
 ## Authors and acknowledgment
 Alisha Evans