Skip to content

Commit

Permalink
chore: update publish scripts (#123)
Browse files Browse the repository at this point in the history
  • Loading branch information
ibgreen authored Aug 4, 2024
1 parent 39be340 commit 2b112b2
Show file tree
Hide file tree
Showing 12 changed files with 67 additions and 12 deletions.
50 changes: 50 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contributing

## Preliminaries

Bug fixes are highly encouraged!

For feature extensions to existing modules, it is generally recommended to start a discussion before you open a PR.

If you have a new module that you think could fit into this repository, please start by opening a GitHub issue to start a discussion, or reach out in the OpenJS slack.
Note that for a new module you will also be asked to asses what level of maintenance you will be able to provide over the longer term.

## Preparations

Most work is done on master.

## Review

Open Visualization team members will make efforts to review your PRs.
As always, clean and focused PRs that do one thing only will be approved and landed faster. Instead of including an unrelated one line fix, consider making a second small PR.

## Landing PRs

Once comments are addressed and the CI tests on GitHub run clean, your PR will be landed by an Open Visualization team member.

## Closing PRs

PRs that do not receive updates to comments for one or two days will be closed, for "repository hygiene" reasons.

If this happens to you and you are coming back to address the PR, just reopen it once you have pushed your changed.

## Fixing CI issues

Unfortunately, many good PRs are closed. By far the most common reason is that the authors can't be bothered to make CI run clean.

Note that CI can usually be fixed in 1-2 minutes as follows:

- `yarn lint fix` - will run `prettier` and `eslint --fix` and fixes 95% of failed CI checks.
- `yarn` - also make sure you run `yarn` to update `yarn.lock` after making changes depdencies in any `package.json` files. For security reasons, GitHub CI will reject your PR if your `yarn.lock` file is out of date with your `package.json` files.

After running these commands just commit and push your PR again and it will likely run green.

## Publishing new versions

Open Visualization team members will make efforts to publish new versions once your PRs land. A good cadence is a weekly patch with any accumulated fixes.

## Official contributors

If you regularly contribute to one of the modules, you may be granted write access to the deck.gl-community GitHub repository allowing you e.g. sto push branches directly instead of working via a GitHub fork.

This is decided by the Open Visualization Technical Steering committee and is based on trust, merit and scope of contributions.
8 changes: 6 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Introduction

This repository contains a collection of "community supported" modules for [deck.gl](https://deck.gl).
It was created to provide a home for a number of excellent deck.gl add-on modules that no longer have active maintainers, with the hope that community contributions will keep them alive
deck.gl-community was created to provide a home for a number of excellent deck.gl add-on modules that no longer have active maintainers, with the hope that community contributions will keep them alive.

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

## Scope
Expand Down Expand Up @@ -45,6 +45,10 @@ For feature extensions to existing modules, it is generally recommended to start
If you have a new module that you think could fit into this repository, please start by opening a GitHub issue to start a discussion, or reach out in the OpenJS slack.
Note that for a new module you will also be asked to asses what level of maintenance you will be able to provide over the longer term.

## Maintainers

We are always looking for long-term or short-term maintainers. If you'd like to work on one of these modules, even if only temporarily, the Open Visualization team is ready to welcome and support you.

## Governance

Final decisions ultimately rest with the OpenJS Open Visualization TSC (Technical Steering Committee), but decisions are often made in the bi-weekly Linux Foundation / OpenJS OpenVisualization meetings which are open to anyone.
2 changes: 1 addition & 1 deletion docs/modules/arrow-layers/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

:::danger
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/bing-maps/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

This module allows [deck.gl](https://deck.gl) to be used as a Bing Maps custom layer.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/editable-layers/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/modules/experimental/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/graph-layers/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/layers/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

![deck.gl v9](https://img.shields.io/badge/deck.gl-v9-green.svg?style=flat-square")
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/react-graph-layers/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

:::danger
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/react/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Overview

:::danger
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If you are expect timely fixes, and you are not able to contribute them yourself, do not use any deck.gl-community module.
The deck.gl-community repo is specifically set up to collect useful code that no longer has dedicated maintainers. This means that there is often no one who can respond quickly to issues. The vis.gl / Open Visualization team members who try to keep this running can only put a few hours into it every now and then. It is important to understand this limitation. If your project depends on timely fixes, and you are not able to contribute them yourself, deck.gl-community modules may not be the right choice for you.
:::

A collection of generic react components to use with deck.gl
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"lint": "ocular-lint",
"lint-fix": "ocular-lint --fix",
"prepublishOnly": "ocular-build && node -e \"const fs = require('fs'); const pkg = JSON.parse(fs.readFileSync('./package.json', {encoding: 'utf8'})); delete pkg.engines; fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2)); console.log(pkg)\"",
"publish": "ocular-publish",
"publish-beta": "ocular-publish beta",
"publish-prod": "ocular-publish prod",
"test": "lerna run test",
"test-ci": "ocular-lint && lerna run test",
"test-fast": "lerna run test",
Expand Down
2 changes: 1 addition & 1 deletion website/src/docs-sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const sidebars = {
{
type: 'category',
label: 'Overview',
items: ['README', 'whats-new', 'upgrade-guide']
items: ['README', 'whats-new', 'upgrade-guide', 'CONTRIBUTING']
},
{
type: 'category',
Expand Down

0 comments on commit 2b112b2

Please sign in to comment.