Skip to content

Commit 2d701e3

Browse files
Callum027Callum Dickinson
authored andcommitted
Add issue templates, update docs version on release
* Add a GitHub issue template for bug reports. * Add a GitHub issue template for tagging releases. * Update the `tag` workflow to make sure that when updating the docs, the new version is added and set to the latest.
1 parent 2840a4b commit 2d701e3

File tree

3 files changed

+83
-1
lines changed

3 files changed

+83
-1
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug Report
3+
about: Submit a bug report for the OpenStack Odoo Client library for Python
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
12+
A clear and concise description of what the bug is.
13+
14+
## To Reproduce
15+
16+
Steps to reproduce the behavior.
17+
18+
## Expected Behavior
19+
20+
A clear and concise description of what you expected to happen.
21+
22+
## Actual Behaviour
23+
24+
An example of what actually happens.
25+
26+
## Environment
27+
28+
- OS: [e.g. Ubuntu 24.04 LTS]
29+
- Python Version: [e.g. 3.14]
30+
- OpenStack Odoo Client Version: [e.g. 0.2.1]
31+
32+
## Additional Information
33+
34+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/release.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Release
3+
about: Tag a new release
4+
title: 'Tag v<version>'
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Replace <version> with the new version to be released, e.g. 0.3.0 -->
11+
12+
1. [ ] Set the version to tag as a variable:
13+
```bash
14+
VERSION=<version>
15+
```
16+
1. [ ] Checkout the latest `main` branch:
17+
```bash
18+
git fetch && git checkout origin/main
19+
```
20+
1. [ ] Create and checkout a new branch for tagging the release:
21+
```bash
22+
git branch tag-${VERSION} && git checkout tag-${VERSION}
23+
```
24+
1. [ ] Generate release notes for the new version:
25+
```bash
26+
uv run towncrier build --version ${VERSION}
27+
```
28+
1. [ ] Commit changes:
29+
```bash
30+
git add -A . && git commit -m "Tag v${VERSION}"
31+
```
32+
1. [ ] Push changes:
33+
```bash
34+
git push -u origin tag-${VERSION}
35+
```
36+
1. [ ] Make a new release tag PR on GitHub and link it here: (PR URL)
37+
1. [ ] Merge the release tag PR.
38+
1. [ ] Checkout the latest `main` branch:
39+
```bash
40+
git fetch && git checkout origin/main
41+
```
42+
1. [ ] Tag and push the latest release:
43+
```bash
44+
git tag ${VERSION} && git push origin ${VERSION}
45+
```
46+
1. [ ] Confirm that the new version was released to PyPI: https://pypi.org/project/python-openstack-odooclient
47+
1. [ ] Confirm that a new release was created on GitHub, and that the release notes are correct: https://github.com/catalyst-cloud/python-openstack-odooclient/releases
48+
1. [ ] Confirm that the docs website has been updated, and the Changelog page has the latest changes: https://catalyst-cloud.github.io/python-openstack-odooclient

.github/workflows/tag.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,6 @@ jobs:
113113
- name: Create virtual environment
114114
run: uv sync --only-dev
115115
- name: Publish the docs to GitHub Pages
116-
run: uv run mike deploy --push develop
116+
run: uv run mike deploy --push --update-aliases "${{ github.ref_name }}" latest
117117
- name: List available docs versions
118118
run: uv run mike list

0 commit comments

Comments
 (0)