Skip to content

Commit

Permalink
feat(repository): migrate default branch to main
Browse files Browse the repository at this point in the history
Migrates the release branch from `master` to `main`
  • Loading branch information
esatterwhite committed Oct 17, 2021
1 parent b16845f commit 2bc8c3a
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 17 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ name: Test + Release
on:
pull_request:
branches:
- master
- main

push:
branch:
- master
- main
jobs:
test:
name: Test Suite
Expand Down
7 changes: 4 additions & 3 deletions .github/workflows/test-release.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
name: Release (dry-run)
on:
push:
pull_request:
branches:
- '!master'
- '!main'


jobs:
release:
name: release
name: Test Release
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![skyring](https://github.com/esatterwhite/skyring/raw/master/assets/skyring.png)
![skyring](https://github.com/esatterwhite/skyring/raw/main/assets/skyring.png)

[![Travis branch](https://img.shields.io/travis/esatterwhite/skyring/master.svg?style=flat-square)](skyring)
[![Travis branch](https://img.shields.io/travis/esatterwhite/skyring/main.svg?style=flat-square)](skyring)
[![npm](https://img.shields.io/npm/v/skyring.svg?style=flat-square)](https://www.npmjs.com/package/skyring)
[![npm](https://img.shields.io/npm/l/skyring.svg?style=flat-square)](https://github.com/esatterwhite/skyring)
[![David](https://img.shields.io/david/esatterwhite/skyring.svg?style=flat-square)](https://david-dm.org/esatterwhite/skyring)
Expand All @@ -23,7 +23,7 @@ A distributed reliable timer service providing `setTimeout` functionality in a d

# Architecture Overview

<img src="https://raw.githubusercontent.com/esatterwhite/skyring/master/assets/skyring-arch.png" width="100%" max-width="800px">
<img src="https://raw.githubusercontent.com/esatterwhite/skyring/main/assets/skyring-arch.png" width="100%" max-width="800px">

## Examples
A request can be issued to any active node in the cluster. If that node is not responsible for the timer in question,
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"tap": "tap",
"nyc": "nyc",
"release": "multi-release",
"release:dry": "multi-release --no-ci --dry-run --branches=${GITHUB_HEAD_REF:-master}",
"release:dry": "multi-release --no-ci --dry-run --branches=${GITHUB_HEAD_REF:-main}",
"test:all": "npm run local tap -- --coverage-report=text --coverage-report=json -Rclassic",
"test:coverage": "tap -Rclassic --coverage-report=json",
"npm:clean": "rm -rf node_modules/ {packages,vendor,examples}/**/node_modules/",
Expand Down
12 changes: 6 additions & 6 deletions packages/skyring/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

![skyring](https://github.com/esatterwhite/skyring/raw/master/assets/skyring.png)
![skyring](https://github.com/esatterwhite/skyring/raw/main/assets/skyring.png)

[![Travis branch](https://img.shields.io/travis/esatterwhite/skyring/master.svg?style=flat-square)](skyring)
[![Travis branch](https://img.shields.io/travis/esatterwhite/skyring/main.svg?style=flat-square)](skyring)
[![npm](https://img.shields.io/npm/v/skyring.svg?style=flat-square)](https://www.npmjs.com/package/skyring)
[![npm](https://img.shields.io/npm/l/skyring.svg?style=flat-square)](https://github.com/esatterwhite/skyring)
[![David](https://img.shields.io/david/esatterwhite/skyring.svg?style=flat-square)](https://david-dm.org/esatterwhite/skyring)
Expand All @@ -18,7 +18,7 @@ A distributed reliable timer service providing `setTimeout` functionality in a d

# Architecture Overview

<img src="https://raw.githubusercontent.com/esatterwhite/skyring/master/assets/skyring-arch.png" width="100%" max-width="800px">
<img src="https://raw.githubusercontent.com/esatterwhite/skyring/main/assets/skyring-arch.png" width="100%" max-width="800px">

# Install

Expand Down Expand Up @@ -104,7 +104,7 @@ Thats it, you have 2 instances running w/ HTTP servers running on ports `3000` a

#### Run via Docker Compose

The Easiest way to run a small cluster is to use the included [compose files](https://github.com/esatterwhite/skyring/blob/master/compose/dev.yml). It is also a good way to see how to quickly configure a cluster
The Easiest way to run a small cluster is to use the included [compose files](https://github.com/esatterwhite/skyring/blob/main/compose/dev.yml). It is also a good way to see how to quickly configure a cluster

- Install [Docker Compose](https://docs.docker.com/compose/install/)

Expand Down Expand Up @@ -190,8 +190,8 @@ skyring run --storage:backend=leveldown --storage:path='/var/data/skyring'
### Custom Storage

In situations when the local disk is not reliable enough, you can install and use any levelup backend to suite your needs.
If, for example you want to off load data storage to a [mongo](https://github.com/esatterwhite/skyring/tree/master/examples/mongo-storage)
or [scylladb](https://github.com/esatterwhite/skyring/tree/master/examples/scylla-storage) cluster, you would just include the backend package
If, for example you want to off load data storage to a [mongo](https://github.com/esatterwhite/skyring/tree/main/examples/mongo-storage)
or [scylladb](https://github.com/esatterwhite/skyring/tree/main/examples/scylla-storage) cluster, you would just include the backend package
as a dependency in your project and specify it by name as the storage package. Options for the backend can be passed via the `storage` attribute

```bash
Expand Down
2 changes: 1 addition & 1 deletion packages/skyring/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"release": {
"extends": "@codedependant/release-config-docker",
"branches": [
"master"
"main"
],
"tarballDir": "dist",
"npmPublish": true,
Expand Down
2 changes: 1 addition & 1 deletion release.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

module.exports = {
extends: '@codedependant/release-config-npm'
, branches: ['master']
, branches: ['main']
}

0 comments on commit 2bc8c3a

Please sign in to comment.