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
You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/community/release.md
+7-14Lines changed: 7 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This guide explains how to create new releases of AutoEmulate for maintainers.
7
7
AutoEmulate uses GitHub Actions to automatically publish releases to PyPI when a new version tag is pushed. The process is as follows:
8
8
9
9
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.
11
11
12
12
Update the version in `pyproject.toml`:
13
13
@@ -17,25 +17,18 @@ name = "autoemulate"
17
17
version = "X.Y.Z"# Update this line
18
18
```
19
19
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):
33
22
34
23
```bash
35
24
git tag vX.Y.Z
36
25
git push origin vX.Y.Z
37
26
```
38
27
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
+
39
32
4.**Automated Release Process using GitHub Actions**
40
33
41
34
When you push a tag matching the pattern 'vX.Y.Z', the release workflow `release.yaml` will automatically:
0 commit comments