relion 0.42.0 â 0.42.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,16 +21,17 @@
|
|
|
21
21
|
<br>
|
|
22
22
|
</div>
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## âī¸ Setup
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
|
|
27
|
+
bun add -D relion # install as dev dependency
|
|
28
|
+
bunx relion # or run directly
|
|
28
29
|
```
|
|
29
30
|
|
|
30
31
|
## đšī¸ CLI Usage
|
|
31
32
|
|
|
32
33
|
```bash
|
|
33
|
-
$
|
|
34
|
+
$ bun relion -h
|
|
34
35
|
|
|
35
36
|
Usage: relion [options]
|
|
36
37
|
|
|
@@ -45,23 +46,23 @@ Options:
|
|
|
45
46
|
-h Show the help message
|
|
46
47
|
|
|
47
48
|
Examples:
|
|
48
|
-
- `
|
|
49
|
-
- `
|
|
50
|
-
- `
|
|
51
|
-
- `
|
|
49
|
+
- `bun relion -bct` â bump version, create release commit and tag
|
|
50
|
+
- `bun relion -f` â generate release context file
|
|
51
|
+
- `bun relion -m Cargo.toml` â use Cargo.toml as manifest
|
|
52
|
+
- `bun relion` â run all release steps
|
|
52
53
|
```
|
|
53
54
|
|
|
54
|
-
<details><summary>Example output of running <code>
|
|
55
|
+
<details><summary>Example output of running <code>bun relion</code>:</summary>
|
|
55
56
|
|
|
56
57
|
```txt
|
|
57
|
-
|
|
58
|
+
Project: relion
|
|
59
|
+
Repo: github.com/kh4f/relion
|
|
58
60
|
Current tag: v0.36.1
|
|
59
61
|
Current version: 0.36.1
|
|
60
62
|
Parsed commits: 16
|
|
61
63
|
New version: 0.37.0
|
|
62
64
|
New tag: v0.37.0
|
|
63
65
|
Commit message: 'chore(release): v0.37.0'
|
|
64
|
-
Repo URL: https://github.com/kh4f/relion
|
|
65
66
|
------------------------------
|
|
66
67
|
|
|
67
68
|
About to write context to 'RELEASE.md'
|
|
@@ -180,7 +181,7 @@ Recommended workflow:
|
|
|
180
181
|
1. Set up GitHub Copilot instruction and prompt:
|
|
181
182
|
- [.github/instructions/changelog-format.instructions.md](.github/instructions/changelog-format.instructions.md)
|
|
182
183
|
- [.github/prompts/generate-changelog.prompt.md](.github/prompts/generate-changelog.prompt.md)
|
|
183
|
-
2. Run the context step to generate RELEASE.md: `
|
|
184
|
+
2. Run the context step to generate RELEASE.md: `bun relion -f`
|
|
184
185
|
3. Review the release context, adjust as needed
|
|
185
186
|
4. Run the prompt in VSCode Copilot chat: `/generate-changelog`
|
|
186
187
|
5. Copilot produces a polished changelog entry based on the release context
|