Skip to content
Permalink
Browse files

ci: setup github actions

  • Loading branch information
ifiokjr committed Jan 5, 2020
1 parent eda97ee commit b39105a0f1ffc8937ec62b97dea9688fe46ec9b0
Showing with 461 additions and 807 deletions.
  1. +34 −0 .github/workflows/ci.yml
  2. +17 −5 CONTRIBUTING.md
  3. +36 −37 README.md
  4. +374 −765 yarn.lock
@@ -0,0 +1,34 @@
name: Node CI

on: [push]

jobs:
build:
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [10.x, 12.x]

steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
# - name: audit dependencies
# run: yarn audit
- name: install dependencies
run: yarn --pure-lockfile
- name: lint files
run: yarn lint
- name: typecheck project
run: yarn typecheck
- name: run unit tests
run: yarn test
- name: build project
run: yarn build
- name: run integration tests
run: yarn test:e2e
env:
CI: true
@@ -4,12 +4,12 @@ Thanks for wanting to contribute to gatsby-plugin-next-seo 😁

We are open to all and any contributions. If you are going to undertake quite a large feature or refactor, maybe open an issue first to start a discussion with the maintainers.

## Project Set Up
## Project Setup

1. Pull the repo and install the dependencies:

```
git clone git@github.com:garmeeh/gatsby-plugin-next-seo.git
git clone git@github.com:ifiokjr/gatsby-plugin-next-seo.git
yarn install
```

@@ -22,11 +22,23 @@ yarn install

All of the library code is located in the `src` directory.

The `e2e` directory contains a fully working Next.js app. This is used in the end to end tests. To run this app first you need to build gatsby-plugin-next-seo. You can then run this app like a normal Next app by running `yarn build` (this builds the local gatsby-plugin-next-seo) followed by `yarn e2e:dev`. You can also run it in a production build by running `yarn e2e:build` followed by `yarn e2e:build`.
The `example` directory contains a fully working GatsbyJS app. This is used in the end to end tests. To run this app first you need to build gatsby-plugin-next-seo from the root directory `yarn build`. You can then run the example gatsby app with

To run Cypress run `yarn build` (this builds the local gatsby-plugin-next-seo) followed by `yarn test:e2e`. Or to run all of the end to end tests headless run `yarn test:e2e:ci`
```bash
yarn e2e:build
yarn e2e:start
```

This builds the local gatsby-plugin-next-seo) followed by `yarn e2e:dev`. You can also run it in a production build by running `yarn e2e:build` followed by `yarn e2e:build`.

To run the end to end tests you can run the following command

```bash
yarn test:e2e # builds everything first
yarn test:e2e:quick # Skips the initial build when all you want is to rerun the tests
```

To run Jest tests run `yarn test`.
To run the unit tests run `yarn test` or `yarn test:watch` to rerun automatically whenever a file changes.

## Being added as Contributor

@@ -1,6 +1,6 @@
# gatsby-plugin-next-seo

[![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors)
![GitHub Actions Build Status](https://github.com/ifiokjr/gatsby-plugin-next-seo/workflows/Node%20CI/badge.svg) [![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors)

Gatsby Plugin SEO makes managing SEO easier in your Gatsby JS project. It fully supports server-side rendering (SSR) with site wide configuration available via the `gatsby-config.js` plugin options. SEO options can also be tweaked at any moment by importing the main `GatsbySeo` component and passing in the desired props.

@@ -11,42 +11,41 @@ This codebase was initially forked from the brilliant [next-seo](https://github.
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [gatsby-plugin-next-seo](#gatsby-plugin-next-seo)
- [Usage](#usage)
- [Setup](#setup)
- [Add Plugin to Gatsby Config](#add-plugin-to-gatsby-config)
- [Add SEO to Page](#add-seo-to-page)
- [Default SEO Configuration](#default-seo-configuration)
- [GatsbySeo Options](#gatsbyseo-options)
- [Title Template](#title-template)
- [No Index](#no-index)
- [dangerouslySetAllPagesToNoIndex](#dangerouslysetallpagestonoindex)
- [No Follow](#no-follow)
- [dangerouslySetAllPagesToNoFollow](#dangerouslysetallpagestonofollow)
- [Twitter](#twitter)
- [facebook](#facebook)
- [Canonical URL](#canonical-url)
- [Alternate](#alternate)
- [Additional Meta Tags](#additional-meta-tags)
- [Open Graph](#open-graph)
- [Open Graph Examples](#open-graph-examples)
- [Basic](#basic)
- [Video](#video)
- [Article](#article)
- [Book](#book)
- [Profile](#profile)
- [JSON-LD](#json-ld)
- [Article](#article-1)
- [Breadcrumb](#breadcrumb)
- [Blog](#blog)
- [Course](#course)
- [Corporate Contact](#corporate-contact)
- [Local Business](#local-business)
- [Logo](#logo)
- [Product](#product)
- [Social Profile](#social-profile)
- [News Article](#news-article)
- [Contributors](#contributors)
- [Usage](#usage)
- [Setup](#setup)
- [Add Plugin to Gatsby Config](#add-plugin-to-gatsby-config)
- [Add SEO to Page](#add-seo-to-page)
- [Default SEO Configuration](#default-seo-configuration)
- [GatsbySeo Options](#gatsbyseo-options)
- [Title Template](#title-template)
- [No Index](#no-index)
- [dangerouslySetAllPagesToNoIndex](#dangerouslysetallpagestonoindex)
- [No Follow](#no-follow)
- [dangerouslySetAllPagesToNoFollow](#dangerouslysetallpagestonofollow)
- [Twitter](#twitter)
- [facebook](#facebook)
- [Canonical URL](#canonical-url)
- [Alternate](#alternate)
- [Additional Meta Tags](#additional-meta-tags)
- [Open Graph](#open-graph)
- [Open Graph Examples](#open-graph-examples)
- [Basic](#basic)
- [Video](#video)
- [Article](#article)
- [Book](#book)
- [Profile](#profile)
- [JSON-LD](#json-ld)
- [Article](#article-1)
- [Breadcrumb](#breadcrumb)
- [Blog](#blog)
- [Course](#course)
- [Corporate Contact](#corporate-contact)
- [Local Business](#local-business)
- [Logo](#logo)
- [Product](#product)
- [Social Profile](#social-profile)
- [News Article](#news-article)
- [Contributors](#contributors)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

0 comments on commit b39105a

Please sign in to comment.
You can’t perform that action at this time.