patch-release-me 0.6.3

A tool to automate patching of your projects before you release them
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

<!-- markdownlint-disable -->
<div align="center">
<h1>Patch Release Me</h1>

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]
[![Crates.io Version](https://img.shields.io/crates/v/patch-release-me?style=for-the-badge)][crates-io]
[![Crates.io Downloads (recent)](https://img.shields.io/crates/dr/patch-release-me?style=for-the-badge)][crates-io]
[![GitHub Stars](https://img.shields.io/github/stars/42ByteLabs/patch-release-me?style=for-the-badge)][github]
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)][license]

</div>
<!-- markdownlint-restore -->

This is a tool I built to help maintain a number of code bases.

## ✨ Features

- Configuration as Code
  - Define how to patch your code before release
- Versioning Helpers

## 📦 Usage

You can install / use the tool is a number of different ways

### Cargo / Crates.io

```bash
cargo install patch-release-me
```

### GitHub Actions

```yaml
- name: "Patch Release Me"
  uses: 42ByteLabs/patch-release-me@0.6.3
  with:
    # Bump (patch)
    mode: bump
```

### Container Image

**Pull Container from GitHub:**

```bash
docker pull ghcr.io/42bytelabs/patch-release-me:0.6.3
```

**Run Image:***

```bash
docker run -it --rm -v $PWD:/app ghcr.io/42bytelabs/patch-release-me:0.6.3 patch-release-me --help
```

### Manual Install 

```bash
cargo install --git https://github.com/42ByteLabs/patch-release-me
```

## Configuration

```yaml
# Project / Repository Version
version: 1.2.3

#[optional]: name of the software you are releasing
name: "patch-release-me"
#[optional]: repository owner/name
repository: "42ByteLabs/patch-release-me"
#[optional]: Ecosystem to use
ecosystems:
  # Only `Rust` tagged defaults will be used
  - "Rust"
#[optional]: Are the default release locations added
default: true

# Patch Locations
locations:
  # Array of objects
  # Name of the patch
  - name: "Docs Patch"
    paths:
      # Glob supported path to the files you want to patch
      - 'Cargo.toml'
    # [optional]: Exclude dirs/files
    excludes:
      - '/target/'
    # Patterns to use to patch the files
    patterns:
      # Regex Patterns to find what version you want to patch which requires
      # a capture group `(...)`. The patterns are checks are runtime.
      - 'version = "([0-9]\.[0-9]\.[0.9])"'
      # You can also use placeholders
      # {version}, {major}, {minor}, {patch}, {repository}
      - 'version = "{version}"'
```

## 🦸 Support

Please create [GitHub Issues][github-issues] if there are bugs or feature requests.

This project uses [Semantic Versioning (v2)][semver] and with major releases, breaking changes will occur.

## 📓 License

This project is licensed under the terms of the MIT open source license.
Please refer to [MIT][license] for the full terms.

<!-- Resources -->
[license]: ./LICENSE
[semver]: https://semver.org/
[github]: https://github.com/42ByteLabs/patch-release-me
[github-issues]: https://github.com/42ByteLabs/patch-release-me/issues
[crates-io]: https://crates.io/crates/patch-release-me