-
Notifications
You must be signed in to change notification settings - Fork 8
Allow the GH issue + Section as --flags and take news via stdin #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
17f62d5
f88da1d
67a6c0c
e79dd63
2106ae6
8217638
4ff5066
f49b7fb
c4cc262
8eb3c4d
eab82d2
e4a7986
14cf97e
c815e4b
e9f388a
5b8a36b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,3 +93,9 @@ ENV/ | |
|
||
# hatch-vcs | ||
src/*/_version.py | ||
|
||
*.bak | ||
*.swp | ||
|
||
CLAUDE.local.md | ||
.claude/* | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -77,6 +77,30 @@ It opens a text editor on a template; you edit the | |
file, save, and exit. **blurb** then stores the file | ||
in the correct place, and stages it in Git for you. | ||
|
||
#### Automation support | ||
|
||
For automated tools and CI systems, `blurb add` supports non-interactive operation: | ||
|
||
```bash | ||
# Add a blurb entry from stdin | ||
echo 'Added beans to the :mod:`spam` module.' | blurb add \ | ||
--issue 123456 \ | ||
--section Library \ | ||
--rst-on-stdin | ||
``` | ||
|
||
When using `--rst-on-stdin`, both `--issue` and `--section` are required. | ||
|
||
The `--issue` parameter accepts various formats: | ||
- Issue number: `--issue 12345` | ||
- With gh- prefix: `--issue gh-12345` | ||
- GitHub URL: `--issue https://github.com/python/cpython/issues/12345` | ||
|
||
The `--section` parameter supports smart matching: | ||
- Case insensitive: `--section library` or `--section LIBRARY` | ||
- Partial matching: `--section lib` (matches "Library") | ||
- Common aliases: `--section api` (matches "C API"), `--section builtin` (matches "Core and Builtins") | ||
|
||
Comment on lines
+80
to
+103
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This adds a new "Automation support" section; this is fine. But then it continues with the usual manual instructions. Let's either move the Automation support" section below the manual stuff, or add another header just here. |
||
The template for the `blurb add` message looks like this: | ||
|
||
# | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,9 @@ classifiers = [ | |
dynamic = [ | ||
"version", | ||
] | ||
dependencies = [ | ||
"cyclopts>=3", | ||
] | ||
Comment on lines
+33
to
+35
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd prefer to avoid an external dependency here, |
||
optional-dependencies.tests = [ | ||
"pyfakefs", | ||
"pytest", | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
from ._version import __version__ | ||
from ._version import __version__ as __version__ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No objection to adding these here, but you may find it easier to add them a personal, global
.gitignore
.