Skip to content

Commit

Permalink
Merge branch 'main' into feat/strongly-typed-model-item-methods
Browse files Browse the repository at this point in the history
  • Loading branch information
tranhl committed Mar 24, 2024
2 parents 704e25b + 1e5b220 commit 0d570ee
Show file tree
Hide file tree
Showing 24 changed files with 13,504 additions and 10,330 deletions.
8 changes: 3 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,12 @@ jobs:
strategy:
matrix:
node-version: [
12.x,
13.x,
14.x,
# 15.x,
16.x,
17.x,
18.x,
19.x
19.x,
20.x,
21.x
]
fail-fast: false
steps:
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v16.15.1
lts/*
35 changes: 35 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,41 @@

---

## Version 4.0.0

This release bumps the minimum required version of Node.js to v16.x.x. It also updates the dependencies to the latest versions.

Please comment or [contact me](https://charlie.fish/contact) if you have any questions about this release.

### 🚨 Breaking Changes 🚨

- Dynamoose now requires Node.js v16.x.x or higher

### Other

- Dependency updates

---

## Version 3.3.0

This release is the final release of the v3.x.x line of Dynamoose. This release includes a few bug fixes.

It is highly recommended to upgrade to v4.x.x as soon as possible. The v4.x.x only has a single breaking change, so the migration process is very easy.

Please comment or [contact me](https://charlie.fish/contact) if you have any questions about this release.

### Bug Fixes

- Fixing issue where index is deleted when projection is set to list of attributes instead of `ALL`
- Fixing issue where `Model.transaction` would fail when using `prefix` and/or `suffix`

### Documentation

- Fixing issue where `Features` tab wasn't showing on sidebar

---

## Version 3.2.1

This release includes some minor bug fixes.
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,8 @@ Below you will find the current branch strategy for the project. Work taking pla

| Branch | Version | NPM Tag | Links |
| --- | --- | --- | --- |
| [`main`](https://github.com/dynamoose/dynamoose/tree/main) | 3.x.x | | - [Documentation](https://dynamoose.pages.dev) |
| [`v3.2.1` (tag)](https://github.com/dynamoose/dynamoose/tree/v3.2.1) | 3.2.1 | latest | - [Documentation](https://dynamoosejs.com) |
| [`main`](https://github.com/dynamoose/dynamoose/tree/main) | 4.x.x | | - [Documentation](https://dynamoose.pages.dev) |
| [`v3`](https://github.com/dynamoose/dynamoose/tree/v3) | 3.3.x | | - [Documentation](https://v3.dynamoose.pages.dev) |
| [`v3.3.0` (tag)](https://github.com/dynamoose/dynamoose/tree/v3.3.0) | 3.3.0 | latest-3 | - [Documentation](https://v3.dynamoosejs.com) |
| [`v2`](https://github.com/dynamoose/dynamoose/tree/v2) | 2.8.x | | - [Documentation](https://v2.dynamoose.pages.dev) |
| [`v2.8.8` (tag)](https://github.com/dynamoose/dynamoose/tree/v2.8.8) | 2.8.8 | latest-2 | - [Documentation](https://v2.dynamoosejs.com)


20 changes: 20 additions & 0 deletions docs/docs_src/Community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The Dynamoose community has created many great projects, tutorials, and other resources to help you in your development with Dynamoose. Below are a list of these resources.

## Packages

- **nestjs-dynamoose** - Dynamoose module for Nest
- [GitHub](https://github.com/hardyscc/nestjs-dynamoose)
- [npm](https://www.npmjs.com/package/nestjs-dynamoose)
- **dynamoose-decorator** - TypeScript decorators for Dynamoose
- [GitHub](https://github.com/p1ayground/dynamoose-decorator)
- [npm](https://www.npmjs.com/package/dynamoose-decorator)

## Tutorials

- **[📺 Introduction to Dynamoose](https://learn.rrainn.com/courses/dd4dc0b8-f97d-4a77-9ce5-337d9bb15771?ref=dynamooseWebsite)**

---

If you would like to add your resource to this list, please click the `Edit this page` link below.

Please note that Dynamoose does not have any association with the above content. If you have any questions or issues with the above content, please contact the respective authors. Dynamoose is not responsible for the content of the above links.
5 changes: 3 additions & 2 deletions docs/docs_src/other/Maintained Versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ More details about our security policy can be found [here](https://github.com/dy

| Version | Bug Fix Updates | Security Updates |
| ------- | ------------------ | ------------------ |
| 3.x.x | :white_check_mark: | :white_check_mark: |
| 2.x.x | :x: | :white_check_mark: |
| 4.x.x | :white_check_mark: | :white_check_mark: |
| 3.x.x | :x: | :x: |
| 2.x.x | :x: | :x: |
| 1.x.x | :x: | :x: |
1 change: 1 addition & 0 deletions docs/docs_src/other/Version Requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ Although extremely rare, it is possible minor or patch versions of Dynamoose wil

| Version | Requirements |
| ------- | -------------------- |
| 4.x.x | - Node.js >= v16.x.x |
| 3.x.x | - Node.js >= v12.x.x |
| 2.x.x | - Node.js >= v8.x.x |
5 changes: 5 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ module.exports = {
"other/Version Requirements"
]
},
{
"type": "doc",
"id": "Community",
"label": "Community"
},
{
"type": "category",
"label": "Sponsored By",
Expand Down
22 changes: 11 additions & 11 deletions docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ html[data-theme="dark"] .header-github-link:before {
div
aside
div
nav
ul
nav.menu
ul.theme-doc-sidebar-menu.menu__list >
li:last-child
ul
li
Expand All @@ -79,7 +79,7 @@ html[data-theme="dark"] .header-github-link:before {
nav
div.navbar-sidebar
div.navbar-sidebar__items.navbar-sidebar__items--show-secondary
ul
ul.theme-doc-sidebar-menu.menu__list >
li:last-child
ul
li
Expand All @@ -94,18 +94,18 @@ html[data-theme="dark"] .header-github-link:before {
div
aside
div
nav
ul
nav.menu
ul.theme-doc-sidebar-menu.menu__list >
li:last-child
div
div.menu__list-item-collapsible
a,
#__docusaurus
nav
div.navbar-sidebar
div.navbar-sidebar__items.navbar-sidebar__items--show-secondary
ul
ul.theme-doc-sidebar-menu.menu__list >
li:last-child
div
div.menu__list-item-collapsible
a {
display: none;
}
Expand All @@ -116,8 +116,8 @@ html[data-theme="dark"] .header-github-link:before {
div
aside
div
nav
ul
nav.menu
ul.theme-doc-sidebar-menu.menu__list >
li:last-child
ul
li
Expand All @@ -126,7 +126,7 @@ html[data-theme="dark"] .header-github-link:before {
nav
div.navbar-sidebar
div.navbar-sidebar__items.navbar-sidebar__items--show-secondary
ul
ul.theme-doc-sidebar-menu.menu__list >
li:last-child
ul
li
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"packages": [
"packages/*"
],
"version": "3.2.1"
"version": "4.0.0"
}

0 comments on commit 0d570ee

Please sign in to comment.