WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit 71aba97

Browse files
Merge pull request #502 from alan-turing-institute/finish-release-031
Bump version to 0.3.1
2 parents 8313413 + 4ca2e4f commit 71aba97

File tree

3 files changed

+8
-34
lines changed

3 files changed

+8
-34
lines changed

CHANGELOG.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/community/release.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This guide explains how to create new releases of AutoEmulate for maintainers.
77
AutoEmulate uses GitHub Actions to automatically publish releases to PyPI when a new version tag is pushed. The process is as follows:
88

99
1. **Update Version Number**
10-
First, give the package a new version. We recommend [this guide](https://py-pkgs.org/07-releasing-versioning.html) to decide on a version number.
10+
First, give the package a new version. We recommend [this guide](https://py-pkgs.org/07-releasing-versioning.html) to decide on a version number. Note: you'll need to open a PR to do this.
1111

1212
Update the version in `pyproject.toml`:
1313

@@ -17,25 +17,18 @@ name = "autoemulate"
1717
version = "X.Y.Z" # Update this line
1818
```
1919

20-
2. **Update CHANGELOG.md**
21-
Add a new section to `CHANGELOG.md` describing the changes in this release. Follow the existing format:
22-
23-
```markdown
24-
## [X.Y.Z] - YYYY-MM-DD
25-
26-
- Added feature X
27-
- Fixed bug Y
28-
- Changed Z
29-
```
30-
31-
3. **Create and Push Tag**
32-
Create a new git tag following semantic versioning (vX.Y.Z):
20+
2. **Create and Push Tag**
21+
Create a new git tag following the same semantic versioning (vX.Y.Z):
3322

3423
```bash
3524
git tag vX.Y.Z
3625
git push origin vX.Y.Z
3726
```
3827

28+
3. **Create a Release on GitHub**
29+
Go to the [Releases page](https://github.com/alan-turing-institute/autoemulate/releases) of the repository and click "Draft a new release".
30+
Fill in the release title and description, then select the tag you just created (vX.Y.Z). You can also link to the relevant issues or pull requests that are included in this release. There is an option to "Generate release notes" which can help summarize changes since the last release.
31+
3932
4. **Automated Release Process using GitHub Actions**
4033

4134
When you push a tag matching the pattern 'vX.Y.Z', the release workflow `release.yaml` will automatically:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "autoemulate"
3-
version = "0.3.0"
3+
version = "0.3.1"
44
description = "A python package for semi-automated emulation"
55
license = "MIT"
66
authors = ["AutoEmulate contributors (see our GitHub page)"]

0 commit comments

Comments
 (0)