Skip to content

Commit

Permalink
chore: update main branch form canary to master
Browse files Browse the repository at this point in the history
  • Loading branch information
ifiokjr committed Mar 5, 2020
1 parent ca4d469 commit 8b81394
Show file tree
Hide file tree
Showing 17 changed files with 106 additions and 123 deletions.
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@
]
],
"access": "public",
"baseBranch": "canary"
"baseBranch": "master"
}
3 changes: 3 additions & 0 deletions .github/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"proseWrap": "never"
}
4 changes: 0 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,4 @@ about: Create a report to help us improve

## Checklist

<!-- prettier-ignore-start -->

- [ ] I have read the [**contributing**](https://github.com/remirror/remirror/blob/canary/docs/contributing.md) document.

<!-- prettier-ignore-end -->
6 changes: 1 addition & 5 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,4 @@ about: Describe this issue template's purpose here.

## Checklist

<!-- prettier-ignore-start -->

- [ ] I have read the [**contributing**](https://github.com/remirror/remirror/blob/canary/docs/contributing.md) document.

<!-- prettier-ignore-end -->
- [ ] I have read the [**contributing**](https://github.com/remirror/remirror/blob/master/docs/contributing.md) document.
7 changes: 1 addition & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ about: Suggest an idea for this project

<!--- Not obligatory, but suggest an idea for implementing addition or change -->

<!-- prettier-ignore-start -->


## Checklist

- [ ] I have read the [**contributing**](https://github.com/remirror/remirror/blob/canary/docs/contributing.md) document.

<!-- prettier-ignore-end -->
- [ ] I have read the [**contributing**](https://github.com/remirror/remirror/blob/master/docs/contributing.md) document.
4 changes: 0 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,11 @@

<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->

<!-- prettier-ignore-start -->

- [ ] I have read the [**contributing**](https://github.com/remirror/remirror/blob/master/docs/contributing.md) document.
- [ ] My code follows the code style of this project and `yarn fix` runs successfully.
- [ ] I have updated the documentation where necessary.
- [ ] New code is unit tested and all current tests pass when running `yarn test` .

<!-- prettier-ignore-end -->

## Screenshots

<!-- Delete this section if not applicable -->
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ jobs:

- name: publish code coverage report
uses: paambaati/codeclimate-action@v2.4.0
if: github.ref == 'refs/heads/canary'
if: github.ref == 'refs/heads/master'
env:
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
with:
coverageCommand: 'echo Coverage'
coverageCommand: "echo Coverage"
debug: false

- name: build project
Expand All @@ -66,7 +66,7 @@ jobs:
run: yarn test:e2e

- name: create release pr or publish to npm
if: github.ref == 'refs/heads/canary'
if: github.ref == 'refs/heads/master'
uses: changesets/action@master
with:
publish: yarn release
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/netlify-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ jobs:
- name: deploy docs
uses: nwtgck/actions-netlify@develop
with:
publish-dir: './docs/public'
publish-dir: "./docs/public"
production-branch: master
github-token: ${{ secrets.GITHUB_TOKEN }}
deploy-message: 'Deploy Docs from GitHub Actions for PR ${{ github.event.pull_request.title }}'
deploy-message: "Deploy Docs from GitHub Actions for PR ${{ github.event.pull_request.title }}"
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
4 changes: 2 additions & 2 deletions @remirror/react-portals/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"ssr",
"text editor"
],
"homepage": "https://github.com/remirror/remirror/tree/canary/@remirror/react-portals",
"repository": "https://github.com/remirror/remirror/tree/canary/@remirror/react-portals",
"homepage": "https://github.com/remirror/remirror/tree/master/@remirror/react-portals",
"repository": "https://github.com/remirror/remirror/tree/master/@remirror/react-portals",
"license": "MIT",
"author": "Ifiok Jr. <ifiokotung@gmail.com>",
"files": [
Expand Down
14 changes: 6 additions & 8 deletions docs/guides/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@ title: Quickstart Guide

# Quickstart Guide

_A really quick way to get started is to [spin up our Next.js
example](https://github.com/remirror/remirror/blob/canary/examples/with-next/readme.md#getting-started)._
_A really quick way to get started is to
[spin up our Next.js example](https://github.com/remirror/remirror/blob/master/examples/with-next/readme.md#getting-started)._

Remirror is comprised of core libraries like `@remirror/core` and UI libraries
like `@remirror/editor-social`.
Remirror is comprised of core libraries like `@remirror/core` and UI libraries like `@remirror/editor-social`.

The easiest way to get started is by using a UI library and for the purposes of
this demonstration we're going to use the package `@remirror/editor-wysiwyg`
The easiest way to get started is by using a UI library and for the purposes of this demonstration we're going
to use the package `@remirror/editor-wysiwyg`

Firstly it needs to be installed.

Expand All @@ -22,9 +21,8 @@ yarn add @emotion/core @remirror/editor-wysiwyg
Then in your code use the following.

```tsx
import React from 'react';

import { WysiwygEditor } from '@remirror/editor-wysiwyg';
import React from 'react';

export const MyWorldClassEditor = () => {
return <WysiwygEditor />;
Expand Down
4 changes: 2 additions & 2 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ React + Prosemirror + Emotion + Typescript = **Love** πŸ₯°

</Banner>

[azure]: https://dev.azure.com/remirror/remirror/_build/latest?definitionId=1&amp;branchName=canary
[azure-badge]: https://dev.azure.com/remirror/remirror/_apis/build/status/ifiokjr.remirror?branchName=canary
[azure]: https://dev.azure.com/remirror/remirror/_build/latest?definitionId=1&amp;branchName=master
[azure-badge]: https://dev.azure.com/remirror/remirror/_apis/build/status/ifiokjr.remirror?branchName=master
[ci]: https://github.com/remirror/remirror/actions?query=workflow%3A%22Node+CI%22
[ci-badge]: https://github.com/remirror/remirror/workflows/Node%20CI/badge.svg
[coverage]: https://codeclimate.com/github/remirror/remirror/coverage
Expand Down
11 changes: 5 additions & 6 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ title: Introduction

Thanks for taking the time to explore this project.

At the moment the focus is on releasing a stable API and while this is ongoing
documentation has slipped from being the priority.
At the moment the focus is on releasing a stable API and while this is ongoing documentation has slipped from
being the priority.

Right now the best way to understand the library is to read through the
codebase and take a look at how existing editors have been structured. A
quick way to get started is to [spin up our Next.js
example](https://github.com/remirror/remirror/blob/canary/examples/with-next/readme.md#getting-started).
Right now the best way to understand the library is to read through the codebase and take a look at how
existing editors have been structured. A quick way to get started is to
[spin up our Next.js example](https://github.com/remirror/remirror/blob/master/examples/with-next/readme.md#getting-started).
2 changes: 1 addition & 1 deletion docs/src/components/edit-link.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ interface EditLinkProps {
}

export const EditLink: FC<EditLinkProps> = ({
base = 'https://github.com/ifiokr/remirror/edit/canary/',
base = 'https://github.com/remirror/remirror/edit/master/',
children = 'Edit the page on GitHub',
relativePath,
...props
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
"prettier --write",
"eslint --fix"
],
"*.{json,yml,yaml,md,mdx}": [
"*.{json,yml,yaml,md}": [
"prettier --write"
],
"{@remirror,packages,docs,support,examples}/**/*.{ts,tsx,js}": [
Expand Down

3 comments on commit 8b81394

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸŽ‰ Published on https://docs.remirror.org as production
πŸš€ Deployed on https://5e61483fcfeaca017c329f04--remirror-docs.netlify.com

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.