https://github.com/icij/datashare-plugin-dataconnect

A Datashare plugin to create Dataconnect, a bridge between Datashare and I-Hub (ICIJ's virtual newsroom).
https://github.com/icij/datashare-plugin-dataconnect

Last synced: 13 days ago
JSON representation

A Datashare plugin to create Dataconnect, a bridge between Datashare and I-Hub (ICIJ's virtual newsroom).

• Host: GitHub
• URL: https://github.com/icij/datashare-plugin-dataconnect
• Owner: ICIJ
• Created: 2020-11-16T11:16:21.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-25T18:50:37.000Z (5 months ago)
• Last Synced: 2024-06-25T20:42:54.334Z (5 months ago)
• Language: Vue
• Homepage:
• Size: 885 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Datashare Plugin : Dataconnect

[![](https://img.shields.io/github/actions/workflow/status/icij/datashare-plugin-dataconnect/main.yml)](https://github.com/ICIJ/datashare-plugin-dataconnect/actions)

A Datashare plugin to create DataConnect, a bridge between Datashare and iHub.

To be used with [datashare-extension-dataconnect](https://github.com/ICIJ/datashare-extension-dataconnect/) and [custom-fields-api](https://github.com/ICIJ/custom-fields-api).

## 🤸 New release

This guide will help you publish a new release by following a few simple steps. We'll ensure your environment is updated, customize your commit message, and create a version tag. Let's get started!

### Step 1: Update Your Local Environment

Before making any changes, ensure that your local repository is synchronized with the latest updates from the remote repository:

```bash

git pull origin main --rebase --tags

```

### Step 2: Customize the Commit Message Format

To keep track of version changes, customize the commit message format for bumping the version. This step ensures that every version bump commit is clearly labeled using semantic commit:

```bash

yarn config set version-git-message "bump: %s"

```

### Step 3: Create a Release Tag

For a **major** version bump (significant changes or backward-incompatible changes), use:

```bash

yarn version --major

```

For a **minor** version bump (backward-compatible new features), use:

```bash

yarn version --minor

```

For a **patch** version bump (backward-compatible bug fixes), use:

```bash

yarn version --patch

```

### Step 4: Push Your Changes to Remote

Finally, push the new version tag to the remote repository. This step triggers the GitHub Action to publish the new release:

```bash

git push origin main --tags

```

Your new release is now published!