Skip to content

Commit

Permalink
Merge pull request #26 from AllSpiceIO/su/changelog-v2.1
Browse files Browse the repository at this point in the history
Update changelog for v2.1.0 release
  • Loading branch information
danielallspice committed Jun 28, 2023
2 parents 20c7876 + 6222256 commit 52a4c3a
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Changelog

## v2.1.0

This is a minor version bump. Only new functionality was added, and you may not
need to change your scripts to update to this version.

- Add APIs to create comments and attachments on Issues. In particular, you can
now use `Issue.create_comment` to add a comment, and
`Comment.create_attachment` to add an attachment to a comment.
- Add APIs for working with Design Reviews. See the `DesignReview` class for
more details, and `Repository.create_design_review` to make one.
- Add more filters for fetching Design Reviews and Issues.
`Repository.get_issues_state` is now deprecated, prefer using
`Repository.get_issues` with a state filter instead.
- Fixed an issue where `Repository.get_branches` only returned the first page of
branches in a repo.
- Add four more example scripts and a top level index for examples. Check
[the examples folder](./examples/) for more examples.

## v2.0.0

This is a breaking change. You will need to update your scripts to use py-allspice v2.
Expand All @@ -8,18 +26,18 @@ This is a breaking change. You will need to update your scripts to use py-allspi

```py
from gitea import Gitea

gitea = Gitea(URL, TOKEN)
```

to

```py
from allspice import AllSpice

allspice_client = AllSpice(token_text=TOKEN)
```

- Added example scripts in [the examples directory](./examples).
- Added functions to get AllSpice generated svg and json for CAD files.
- Added optional Rate Limiting to the client. By default, Rate Limiting is on at 100
Expand Down

0 comments on commit 52a4c3a

Please sign in to comment.