Skip to content

Commit

Permalink
update deployment and instructions (#193)
Browse files Browse the repository at this point in the history
* update deployment and instructions

* Correct current version number

---------

Co-authored-by: rowanhemsi <rowan.hemsi@ons.gov.uk>
  • Loading branch information
gisellerosetta and rowanhemsi authored Jul 17, 2024
1 parent bb4f56b commit 2990c06
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 14 deletions.
10 changes: 0 additions & 10 deletions .bumpversion.cfg

This file was deleted.

21 changes: 21 additions & 0 deletions .bumpversion.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[tool.bumpversion]
current_version = "2023.2"
parse = "(?P<year>\\d+)\\.(?P<build>\\d+)"
serialize = ["{year}.{build}"]
tag = true
sign_tags = false
tag_name = "v{new_version}"
tag_message = "Bump version: {current_version} → {new_version}"
allow_dirty = false
commit = true
message = "Bump version: {current_version} → {new_version}"

[[tool.bumpversion.files]]
filename = "book/_config.yml"
search = "Book version {current_version}"
replace = "Book version {new_version}"

[[tool.bumpversion.files]]
filename = "book/intro.md"
search = "(version {current_version})"
replace = "(version {new_version})"
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,16 +92,16 @@ pip install -r dev-requirements.txt

### Releasing

To create a new release, use the command line tool `bump2version`, which will be installed with the dev dependencies.
To create a new release, use the command line tool `bump-my-version`, which will be installed with the dev dependencies.
The version number references the current `year` and an incremental `build` count.

For a the first release of a year, provide the `year` as the command argument, otherwise provide `build`.

```{none}
bump2version build
bump-my-version bump year
```

`bumpversion` will create a new Git `tag` and `commit`.
`bump-my-version` will create a new Git `tag` and `commit`.
If you're happy with the version increase, `push` these to the remote to trigger the publication, by running both:

```{none}
Expand Down
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
bump2version
bump-my-version
pre-commit
pymarkdownlnt

0 comments on commit 2990c06

Please sign in to comment.