Skip to content

Commit 3298f89

Browse files
dalisoftdalisoft
committed
docs(website): update plugins page
1 parent 72fcb27 commit 3298f89

File tree

13 files changed

+210
-59
lines changed

13 files changed

+210
-59
lines changed

‎.vscode/settings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@
99
},
1010
"[shellscript]": {
1111
"editor.defaultFormatter": "foxundermoon.shell-format"
12-
}
12+
},
13+
"markdown.validate.ignoredLinks": ["./category/plugins"]
1314
}

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
55
[![Coverage Status](https://coveralls.io/repos/github/dalisoft/release-me/badge.svg?branch=master)](https://coveralls.io/github/dalisoft/release-me?branch=master)
66

7-
Blazing fast minimal release workflow script written in **Bash** with plugins and presets support
7+
Fast minimal release workflow script written in **Bash** with plugins and presets support
88

99
## Features
1010

1111
- Available on all **Unix** environments
1212
- Zero third-party dependencies
1313
- No pre-install, just use
14-
- Blazing fast, no wait
14+
- Fast and no wait
1515
- Workspace support out-of-box
1616
- Programming language agnostic
1717
- Fast (<5 sec with all plugins execution)

‎docs/CONFIGURATION.md

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,7 @@ sidebar_position: 5
44

55
# Configuration
66

7-
## Environment variables
8-
9-
| Name | Description | Type | Depended plugin |
10-
| -------------- | ----------------------------------- | ------- | ------------------------- |
11-
| `GITHUB_TOKEN` | Used to publish **Github** releases | Secrets | **GitHub Release** plugin |
12-
| `NPM_TOKEN` | Used to publish to **npm** registry | Secrets | **npm** plugin |
13-
14-
## Git variables
15-
16-
> These variable names used for creating tag(s)
17-
18-
| Name | Description | Type | Depended plugin |
19-
| -------------- | ------------------------- | --------- | ----------------------- |
20-
| `GIT_USERNAME` | Specify tag author name | Variables | **git,npm-post** plugin |
21-
| `GIT_EMAIL` | Specify tag author e-mail | Variables | **git,npm-post** plugin |
22-
23-
## GPG (Git) variables
24-
25-
> These variable names used for signing tag(s)
26-
27-
| Name | Description | Type | Depended plugin |
28-
| ---------------- | ---------------------- | --------- | ----------------------- |
29-
| `GPG_NO_SIGN` | Skips Git Signing | Variables | **git,npm-post** plugin |
30-
| `GPG_KEY_ID` | Public GPG key/ring ID | Variables | **git,npm-post** plugin |
31-
| `GPG_KEY` | Private GPG key | Secrets | **git,npm-post** plugin |
32-
| `GPG_PASSPHRASE` | Private GPG passphrase | Secrets | **git,npm-post** plugin |
33-
34-
## SSH (Git) variables
35-
36-
> These variable names used for signing tag(s)
37-
38-
| Name | Description | Type | Depended plugin |
39-
| -------------------- | ----------------------- | --------- | ----------------------- |
40-
| `SSH_NO_SIGN` | Skips Git Signing | Variables | **git,npm-post** plugin |
41-
| `SSH_PUBLIC_KEY` | Public SSH key content | Secrets | **git,npm-post** plugin |
42-
| `SSH_PRIVATE_KEY` | Private SSH key content | Secrets | **git,npm-post** plugin |
43-
| `SSH_KEY_PASSPHRASE` | Private SSH passphrase | Secrets | **git,npm-post** plugin |
7+
## See [plugins](./category/plugins)
448

459
## GH Actions Configurations
4610

‎docs/GET_STARTED.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Before you start using release-me, make sure you have the following installed on
3232
- Available on all **Unix** environments
3333
- Zero third-party dependencies
3434
- No pre-install, just use
35-
- Blazing fast, no wait
35+
- Fast and no wait
3636
- [Workspace](./features/WORKSPACE.md) support out-of-box
3737
- Programming language agnostic
3838
- [Fast](./BENCHMARK.md) (<5 sec with all plugins execution)
39-
- [Plugins](./PLUGINS.md) available/compatible
39+
- [Plugins](./category/plugins) available/compatible
4040
- [Presets](./PRESETS.md) available/compatible
4141
- Free and permissive license
4242

‎docs/PLUGINS.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎docs/USAGE.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ This project can be used as you wish, local, remote, on CI and/or at VPS. Everyw
99
## Requirements
1010

1111
> See [Getting Started](./GET_STARTED.md) page if you didn't read
12-
> See [Environment variables](./CONFIGURATION.md#environment-variables)
12+
> See [Configuration](./CONFIGURATION.md)
13+
> See [Plugins](./category/plugins)
1314
1415
- **bash** version **v5+** for best reliability
1516
- Make sure you have **write** access
@@ -42,7 +43,7 @@ bash .release-me/release.sh --plugins=git,github-release --preset=conventional-c
4243
| `stable` | If project current version is `0.x`, it will bump to `1.x` | `false` | No |
4344
| `pre-release` | Publish this project as non-production ready | `false` | No |
4445
| `preset` | Presets compatibility, see [Presets](./PRESETS.md) | `conventional-commits` | No |
45-
| `plugins` | Plugins compatibility, see [Plugins](./PLUGINS.md) | `git` | No |
46+
| `plugins` | Plugins compatibility, see [Plugins](./category/plugins) | `git` | No |
4647

4748
### `dry-run`
4849

@@ -176,6 +177,6 @@ This option helps you keep your project as alpha release easier than ever or all
176177
- Default: `git`
177178
- Type: `string`
178179
- Requires: `Yes`
179-
- Values: String of Array of [Plugins](/docs/PLUGINS.md)
180+
- Values: String of Array of [Plugins](/docs/plugins/docker.md)
180181
- Example: `release-me --plugins=npm-post,npm,git,github-release`
181182
- Used by: **Core** features

‎docs/plugins/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Plugins",
3+
"position": 7,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Plugins"
7+
}
8+
}

‎docs/plugins/changelogs.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Changelog
6+
7+
Generates `CHANGELOG` within your project
8+
9+
## Required: **No**
10+
11+
## Usage
12+
13+
```bash title="Bash (Terminal)"
14+
git clone https://github.com/dalisoft/release-me.git --depth 1 .release-me
15+
bash .release-me/release.sh --plugins=git,changelog
16+
```

‎docs/plugins/docker.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# Docker
6+
7+
Publishes `docker` image to **Docker Hub**
8+
9+
## Required: **No**
10+
11+
## Environment variables
12+
13+
| Name | Description | Type |
14+
| --------------------- | ------------------- | ------- |
15+
| `DOCKER_HUB_USERNAME` | Docker username | Secrets |
16+
| `DOCKER_HUB_PAT` | Docker Access Token | Secrets |
17+
18+
## Usage
19+
20+
```bash title="Bash (Terminal)"
21+
git clone https://github.com/dalisoft/release-me.git --depth 1 .release-me
22+
bash .release-me/release.sh --plugins=git,docker
23+
```

‎docs/plugins/git.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Git
6+
7+
Creates **Git** tag and push to origin.
8+
9+
This plugin is essential for working properly entire project and idea of this project
10+
11+
## Required: **Yes**
12+
13+
## Environment Variables
14+
15+
### Git variables
16+
17+
> These variable names used for creating tag(s)
18+
19+
| Name | Description | Type |
20+
| -------------- | ------------------------- | --------- |
21+
| `GIT_USERNAME` | Specify tag author name | Variables |
22+
| `GIT_EMAIL` | Specify tag author e-mail | Variables |
23+
24+
### GPG (Git) variables
25+
26+
> These variable names used for signing tag(s)
27+
28+
| Name | Description | Type |
29+
| ---------------- | ---------------------- | --------- |
30+
| `GPG_NO_SIGN` | Skips Git Signing | Variables |
31+
| `GPG_KEY_ID` | Public GPG key/ring ID | Variables |
32+
| `GPG_KEY` | Private GPG key | Secrets |
33+
| `GPG_PASSPHRASE` | Private GPG passphrase | Secrets |
34+
35+
### SSH (Git) variables
36+
37+
> These variable names used for signing tag(s)
38+
39+
| Name | Description | Type |
40+
| -------------------- | ----------------------- | --------- |
41+
| `SSH_NO_SIGN` | Skips Git Signing | Variables |
42+
| `SSH_PUBLIC_KEY` | Public SSH key content | Secrets |
43+
| `SSH_PRIVATE_KEY` | Private SSH key content | Secrets |
44+
| `SSH_KEY_PASSPHRASE` | Private SSH passphrase | Secrets |
45+
46+
## Usage
47+
48+
```bash title="Bash (Terminal)"
49+
git clone https://github.com/dalisoft/release-me.git --depth 1 .release-me
50+
bash .release-me/release.sh --plugins=git
51+
```

0 commit comments

Comments
 (0)