Skip to content

Commit 40ce3a8

Browse files
committed
fix code blocks and version parsing
1 parent e731a94 commit 40ce3a8

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ package-test: clean
8080

8181
notes: check-bump
8282
# Let UPCOMING_VERSION be the version that is used for the current bump
83-
$(eval UPCOMING_VERSION=$(shell bump-my-version show --increment $(bump) new_version))
83+
$(eval UPCOMING_VERSION=$(shell bump-my-version bump --dry-run $(bump) -v | awk -F"'" '/New version will be / {print $$2}'))
8484
# Now generate the release notes to have them included in the release commit
8585
towncrier build --yes --version $(UPCOMING_VERSION)
8686
# Before we bump the version, make sure that the towncrier-generated docs will build

docs/contributing.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ To get started, fork the repository to your own github account, then clone it to
1212
development machine:
1313

1414
.. code:: sh
15+
1516
git clone [email protected]:your-github-username/<REPO_NAME>.git
1617
1718
Next, install the development dependencies. We recommend using a virtual environment,
1819
such as `virtualenv <https://virtualenv.pypa.io/en/stable/>`_.
1920

2021
.. code:: sh
22+
2123
cd <REPO_NAME>
2224
virtualenv -p python venv
2325
. venv/bin/activate
@@ -32,6 +34,7 @@ A great way to explore the code base is to run the tests.
3234
We can run all tests with:
3335

3436
.. code:: sh
37+
3538
pytest tests
3639
3740
Code Style
@@ -42,6 +45,7 @@ the library. This tool runs automatically with every commit, but you can also ru
4245
manually with:
4346

4447
.. code:: sh
48+
4549
make lint
4650
4751
If you need to make a commit that skips the ``pre-commit`` checks, you can do so with
@@ -91,6 +95,7 @@ Final test before each release
9195
Before releasing a new version, build and test the package that will be released:
9296

9397
.. code:: sh
98+
9499
git checkout main && git pull
95100
make package-test
96101
@@ -100,6 +105,7 @@ the instructions to activate the venv and test whatever you think is important.
100105
You can also preview the release notes:
101106

102107
.. code:: sh
108+
103109
towncrier --draft
104110
105111
Build the release notes
@@ -110,6 +116,7 @@ the version to bump (see below), which changes how the version number will show
110116
release notes.
111117

112118
.. code:: sh
119+
113120
make notes bump=$$VERSION_PART_TO_BUMP$$
114121
115122
If there are any errors, be sure to re-run make notes until it works.
@@ -120,6 +127,7 @@ Push the release to github & pypi
120127
After confirming that the release package looks okay, release a new version:
121128

122129
.. code:: sh
130+
123131
make release bump=$$VERSION_PART_TO_BUMP$$
124132
125133
This command will:

0 commit comments

Comments
 (0)