Skip to content

Commit 6d13146

Browse files
committed
chore: fix releasing task, update docs related
1 parent 463c445 commit 6d13146

File tree

2 files changed

+14
-29
lines changed

2 files changed

+14
-29
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
LUA_VERSION = 5.1
22
DEPS_DIR = deps
33
TEST_DIR = tests
4-
ROCKSPEC = copy_with_context-3.0.0-1.rockspec
4+
ROCKSPEC = $(shell ls copy_with_context-*.rockspec | head -1)
55
BUSTED = $(DEPS_DIR)/bin/busted
66
LUACHECK = $(DEPS_DIR)/bin/luacheck
77

RELEASING.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -108,19 +108,11 @@ source = {
108108
- Verify all modules are listed in `build.modules` if you added new files
109109
- Dependencies should only include runtime dependencies (not luacheck, busted, etc.)
110110

111-
### 5. Update Makefile
112-
113-
Update the `ROCKSPEC` variable in `Makefile`:
114-
115-
```makefile
116-
ROCKSPEC = copy_with_context-X.Y.Z-1.rockspec # Update this
117-
```
118-
119-
### 6. Commit Version Bump
111+
### 5. Commit Version Bump
120112

121113
```bash
122114
# Stage the changes
123-
git add copy_with_context-*.rockspec Makefile
115+
git add copy_with_context-*.rockspec
124116

125117
# Commit with conventional commit message
126118
git commit -m "chore: bump version to X.Y.Z"
@@ -129,7 +121,7 @@ git commit -m "chore: bump version to X.Y.Z"
129121
git push origin main
130122
```
131123

132-
### 7. Create Git Tag
124+
### 6. Create Git Tag
133125

134126
```bash
135127
# Create an annotated tag
@@ -158,7 +150,7 @@ git push origin vX.Y.Z
158150
- Format: `vMAJOR.MINOR.PATCH`
159151
- Examples: `v3.0.0`, `v2.1.5`, `v1.0.0-rc.1`
160152

161-
### 8. Create GitHub Release
153+
### 7. Create GitHub Release
162154

163155
1. Go to https://github.com/zhisme/copy_with_context.nvim/releases
164156
2. Click **"Draft a new release"**
@@ -210,7 +202,7 @@ Full documentation: [README.md](./README.md)
210202
6. Check **"Set as the latest release"** (unless it's a pre-release)
211203
7. Click **"Publish release"**
212204

213-
### 9. Publish to LuaRocks (Optional)
205+
### 8. Publish to LuaRocks (Optional)
214206

215207
If you want to publish to [LuaRocks](https://luarocks.org/):
216208

@@ -224,7 +216,7 @@ luarocks upload copy_with_context-X.Y.Z-1.rockspec --api-key YOUR_API_KEY
224216

225217
**Note:** You need a LuaRocks account and to be a maintainer of the package.
226218

227-
### 10. Post-Release Tasks
219+
### 9. Post-Release Tasks
228220

229221
- [ ] Verify the release appears on GitHub Releases page
230222
- [ ] Verify the tag is visible: `git tag -l`
@@ -315,14 +307,6 @@ luarocks lint copy_with_context-X.Y.Z-1.rockspec
315307
luarocks make copy_with_context-X.Y.Z-1.rockspec
316308
```
317309

318-
### Wrong Rockspec in Makefile
319-
320-
Make sure `Makefile` references the correct version:
321-
322-
```makefile
323-
ROCKSPEC = copy_with_context-X.Y.Z-1.rockspec
324-
```
325-
326310
### Release Notes Script Not Working
327311

328312
```bash
@@ -342,14 +326,15 @@ git tag -l
342326
- Check if CI is passing for the tag
343327
- Verify you have write access to the repository
344328

345-
## Automation (Future)
329+
## Automation
346330

347-
The release process can be automated with GitHub Actions. A workflow will be added in the future to:
331+
The release process is partially automated with GitHub Actions (`.github/workflows/release.yml`):
348332

349-
- Automatically create GitHub releases when tags are pushed
350-
- Run tests before releasing
351-
- Auto-generate release notes from commits
352-
- Optionally publish to LuaRocks
333+
- ✅ Automatically creates GitHub releases when tags are pushed
334+
- ✅ Runs tests before releasing
335+
- ✅ Validates rockspec before releasing
336+
- ✅ Auto-generates release notes from commits
337+
- ❌ Publishing to LuaRocks (still manual - see step 8)
353338

354339
## Additional Resources
355340

0 commit comments

Comments
 (0)