Compare commits
9 Commits
release_bu
...
v0.2.0
| Author | SHA1 | Date | |
|---|---|---|---|
| b221fa3534 | |||
| a24cc8f2b9 | |||
|
|
d7330933bc | ||
| ac32bae975 | |||
|
|
b181e31a0c | ||
| 4fd1243472 | |||
|
|
328eeaca7a | ||
| 19b79b26ff | |||
|
|
a67e31c65d |
48
.github/workflows/publish.yml
vendored
48
.github/workflows/publish.yml
vendored
@@ -1,48 +0,0 @@
|
|||||||
name: Publish to PyPI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- "*"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-publish:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Python
|
|
||||||
uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: "3.13"
|
|
||||||
|
|
||||||
- name: Install Poetry
|
|
||||||
uses: snok/install-poetry@v1
|
|
||||||
with:
|
|
||||||
version: 1.8.4
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: poetry install --no-root --only main
|
|
||||||
|
|
||||||
- name: Build package
|
|
||||||
run: poetry build
|
|
||||||
|
|
||||||
- name: Generate checksums
|
|
||||||
run: |
|
|
||||||
cd dist
|
|
||||||
for file in *; do
|
|
||||||
sha256sum "$file" > "$file.sha256"
|
|
||||||
done
|
|
||||||
|
|
||||||
- name: Publish to PyPI
|
|
||||||
env:
|
|
||||||
POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
|
|
||||||
run: poetry publish
|
|
||||||
|
|
||||||
- name: Upload artifacts to GitHub Release
|
|
||||||
uses: softprops/action-gh-release@v1
|
|
||||||
with:
|
|
||||||
files: |
|
|
||||||
dist/*
|
|
||||||
18
.github/workflows/release-please.yml
vendored
18
.github/workflows/release-please.yml
vendored
@@ -1,18 +0,0 @@
|
|||||||
name: Release Please
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: ["main"]
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
release-please:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Release Please
|
|
||||||
uses: googleapis/release-please-action@v4
|
|
||||||
with:
|
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,3 +1,3 @@
|
|||||||
__pycache__
|
__pycache__
|
||||||
.pytest_cache
|
.pytest_cache
|
||||||
dist
|
dist
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
{
|
|
||||||
".": "0.1.1"
|
|
||||||
}
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
# How to Contribute to `resrm`
|
|
||||||
|
|
||||||
Thanks for your interest in contributing to `resrm`! This guide walks you through the process step by step so you can send contributions with confidence.
|
|
||||||
|
|
||||||
### For external contributors
|
|
||||||
|
|
||||||
1. **Fork the repository** via GitHub: click *Fork* at the top right.
|
|
||||||
2. **Clone your fork**:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/<your-username>/resrm.git
|
|
||||||
cd resrm
|
|
||||||
```
|
|
||||||
3. **Add the upstream repo** so you can sync later:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git remote add upstream https://github.com/mdaleo404/resrm.git
|
|
||||||
```
|
|
||||||
4. **Create a feature branch**:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git checkout -b feature/my-new-thing
|
|
||||||
```
|
|
||||||
5. Make your changes and test them locally.
|
|
||||||
6. **Push to your fork**:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git push -u origin feature/my-new-thing
|
|
||||||
```
|
|
||||||
7. Open a **Pull Request** targeting the `main` branch of the upstream repo.
|
|
||||||
|
|
||||||
### For maintainers
|
|
||||||
|
|
||||||
You may create branches directly in the main repository without forking.
|
|
||||||
|
|
||||||
## Commit Message Style Commit Message Style
|
|
||||||
|
|
||||||
To keep the automated changelog clean, follow this commit style:
|
|
||||||
|
|
||||||
**Format:**
|
|
||||||
|
|
||||||
```
|
|
||||||
type: short description
|
|
||||||
```
|
|
||||||
|
|
||||||
**Accepted types:**
|
|
||||||
|
|
||||||
* `feat:` new features
|
|
||||||
* `fix:` bug fixes
|
|
||||||
* `refactor:` internal improvements
|
|
||||||
* `perf:` performance changes
|
|
||||||
* `docs:` documentation updates
|
|
||||||
* `chore:` maintenance
|
|
||||||
* `test:` test-only changes
|
|
||||||
|
|
||||||
**Examples:**
|
|
||||||
|
|
||||||
```
|
|
||||||
feat: add --dry-run flag
|
|
||||||
fix: handle unicode paths
|
|
||||||
refactor: simplify cleanup logic
|
|
||||||
```
|
|
||||||
|
|
||||||
Don’t overthink it — the maintainer can adjust commit types during merge if needed.
|
|
||||||
|
|
||||||
## What Happens After You Submit a PR?
|
|
||||||
|
|
||||||
After reviewing your changes, your PR (hopefully) gets merged. Then:
|
|
||||||
|
|
||||||
* **Release Please** automatically creates a **release PR** summarizing changes
|
|
||||||
* The maintainer merges that release PR
|
|
||||||
* A GitHub Release is created
|
|
||||||
* The package is published to PyPI
|
|
||||||
* Wheels, source tarballs, and checksums are attached to the GitHub Release
|
|
||||||
|
|
||||||
No need to bump versions manually (unless needed).
|
|
||||||
|
|
||||||
## Code Style
|
|
||||||
|
|
||||||
* Follow standard Python formatting
|
|
||||||
* Add type hints when possible
|
|
||||||
* Keep functions small and readable
|
|
||||||
* Stick to clear naming
|
|
||||||
|
|
||||||
## Need Help, Found a Bug, Have a Request?
|
|
||||||
|
|
||||||
If you're unsure about anything:
|
|
||||||
|
|
||||||
* **Open an issue**
|
|
||||||
* Start a discussion
|
|
||||||
* Ask questions before writing lots of code
|
|
||||||
|
|
||||||
## Thank You
|
|
||||||
|
|
||||||
Your contributions — large or small — help make `resrm` better for everyone. Thanks for being part of the project!
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"release-type": "python",
|
|
||||||
"package-name": "resrm",
|
|
||||||
"changelog-sections": [
|
|
||||||
{ "type": "feat", "section": "Added", "hidden": false },
|
|
||||||
{ "type": "fix", "section": "Fixed", "hidden": false },
|
|
||||||
{ "type": "refactor", "section": "Changed", "hidden": false },
|
|
||||||
{ "type": "perf", "section": "Changed", "hidden": false },
|
|
||||||
{ "type": "docs", "section": "Documentation", "hidden": false }
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "resrm"
|
name = "resrm"
|
||||||
version = "0.1.1"
|
version = "0.2.0"
|
||||||
description = "drop-in replacement for rm with undo/restore built-in."
|
description = "drop-in replacement for rm with undo/restore built-in."
|
||||||
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
||||||
license = "GPL-3.0-or-later"
|
license = "GPL-3.0-or-later"
|
||||||
|
|||||||
Reference in New Issue
Block a user