-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
50 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,55 @@ | ||
# Datashare Plugin : Site Alert | ||
|
||
[![Circle CI](https://circleci.com/gh/ICIJ/datashare-plugin-site-alert.png?style=shield&circle-token=bb83a70d5a43a31c6fd38d797f015b9419c15ffe)](https://circleci.com/gh/ICIJ/datashare-plugin-site-alert) | ||
[![](https://img.shields.io/github/actions/workflow/status/icij/datashare-plugin-site-alert/main.yml)](https://github.com/ICIJ/datashare-plugin-site-alert/actions) | ||
|
||
A Datashare plugin to display an alert banner on the Datashare demo instance. | ||
A Datashare plugin to display an alert banner on the Datashare demo instance. | ||
|
||
## Create a new release | ||
`make RELEASE_VERSION=your_release_version GITHUB_API_TOKEN=your_github_api_token release` | ||
## 🤸 New release | ||
|
||
Please see [here](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) to create or get you API token. | ||
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! |