feat: integrate Yalc

Author: DanailMinchev

.github/workflows/ci.yml

@@ -42,10 +42,22 @@ jobs:
         run: |
           cd packages/gatsby-theme-minimal
           npm ci
+      - name: Test [packages/gatsby-theme-minimal]
+        run: |
+          cd packages/gatsby-theme-minimal
+          npm test
+      - name: Yalc Publish [packages/gatsby-theme-minimal]
+        run: |
+          cd packages/gatsby-theme-minimal
+          npx yalc publish
+      - name: Add Yalc Dependencies [examples/gatsby-starter-testing]
+        run: |
+          cd examples/gatsby-starter-testing
+          npx yalc add gatsby-theme-minimal
       - name: Install Dependencies [examples/gatsby-starter-testing]
         run: |
           cd examples/gatsby-starter-testing
-          npm ci
+          npm install --force
       - name: Test [examples/gatsby-starter-testing]
         run: |
           cd examples/gatsby-starter-testing

README.md

@@ -35,6 +35,10 @@
 
 ## Installation
 
+### Install dependencies
+
+Navigate to repository root path and execute following:
+
 ```shell
 npm ci
 
@@ -45,9 +49,65 @@ cd ../../examples/gatsby-starter-testing
 npm ci
 ```
 
+### Initialise [Yalc](https://github.com/wclr/yalc)
+
+Navigate to repository root path and execute following:
+
+- Navigate to `gatsby-theme-minimal` package and publish `gatsby-theme-minimal` package to local Yalc repository:
+
+```shell
+cd packages/gatsby-theme-minimal
+npx yalc publish
+```
+
+- Navigate to `gatsby-starter-testing` example and add `gatsby-theme-minimal` package dependency:
+
+```shell
+cd ../../examples/gatsby-starter-testing
+npx yalc add gatsby-theme-minimal
+npm install
+```
+
+## Update gatsby-theme-minimal changes
+
+Once `gatsby-theme-minimal` package is changed and you would like to test it in `gatsby-starter-testing` example,
+you will need to update the dependencies and Yalc configuration.
+<br />
+Navigate to `gatsby-theme-minimal` package from the repository root path and publish `gatsby-theme-minimal` package with `--push` flag:
+
+```shell
+cd packages/gatsby-theme-minimal
+npx yalc publish --push
+```
+
+You can use `npx yalc push` shortcut instead of `npx yalc publish --push`.
+<br />
+
+If `gatsby-theme-minimal` package changed its own dependencies you will need to execute `npm install` as well in the examples/gatsby-starter-testing:
+
+```shell
+cd ../../examples/gatsby-starter-testing
+npm install --force
+```
+
 ## Directory structure
 
-TODO
+### packages/gatsby-theme-minimal
+
+The Gatsby theme is located in `packages/gatsby-theme-minimal` and it is used in the example app.
+
+### examples/gatsby-starter-testing
+
+The example Gatsby app which is using the Gatsby theme is located in `examples/gatsby-starter-testing`.
+
+This example app is based on [Gatsby Testing Starter](https://github.com/DanailMinchev/gatsby-starter-testing) and
+it has configured `packages/gatsby-theme-minimal` dependency using Yalc.
+
+The `packages/gatsby-theme-minimal` dependency is stored in `.yalc` directory and it is managed by Yalc using `yalc.lock` file.
+
+## GitHub Actions CI pipeline
+
+This repostiory is intergared with GitHub Actions and has CI pipeline defined in [.github/workflows/ci.yml](.github/workflows/ci.yml).
 
 ## Repository configuration
 

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/.nvmrc

@@ -0,0 +1 @@
+v16.1.0

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/.prettierignore

@@ -0,0 +1,82 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variable files
+.env*
+
+# gatsby files
+.cache/
+public
+
+# Mac files
+.DS_Store
+
+# Yarn
+yarn-error.log
+.pnp/
+.pnp.js
+# Yarn Integrity file
+.yarn-integrity
+
+# JetBrains
+.idea
+
+# Cypress files
+cypress/videos
+cypress/screenshots
+
+# Storybook files
+storybook-static
+
+# Storybook and jest-image-snapshot files
+__diff_output__

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "arrowParens": "avoid",
+  "semi": false
+}

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/.releaserc

@@ -0,0 +1,3 @@
+{
+  "preset": "conventionalcommits"
+}

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at danail.dev@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).
+By participating in this project you agree to abide by its terms.
+
+---
+
+Ensure your pull request adheres to the following guidelines:
+
+- Search previous suggestions before making a new one, as yours may be a duplicate.
+- Make an individual pull request for each suggestion.
+- Check your spelling and grammar.
+- The pull request and commit should have a useful title.
+- The commit messages must be compatible with [Conventional Commits](https://www.conventionalcommits.org/) specification.
+
+## Updating your Pull Request
+
+A lot of times, making a PR adhere to the standards above can be difficult.
+If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it.
+There's no need to open a new PR, just edit the existing one.

examples/gatsby-starter-testing/.yalc/gatsby-theme-minimal/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Danail Minchev
+
+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.