Browse Source

Add changelog file and tool configuration (#1546)

Add changelog file and tool configuration

Reviewed-on: #1546
tags/v1.0.0
Lunny Xiao 1 month ago
parent
commit
f3d9c49635
3 changed files with 219 additions and 0 deletions
  1. +57
    -0
      .changelog.yml
  2. +121
    -0
      CHANGELOG.md
  3. +41
    -0
      CONTRIBUTING.md

+ 57
- 0
.changelog.yml View File

@@ -0,0 +1,57 @@
# The full repository name
repo: xorm/xorm

# Service type (gitea or github)
service: gitea

# Base URL for Gitea instance if using gitea service type (optional)
# Default: https://gitea.com
base-url:

# Changelog groups and which labeled PRs to add to each group
groups:
-
name: BREAKING
labels:
- kind/breaking
-
name: FEATURES
labels:
- kind/feature
-
name: SECURITY
labels:
- kind/security
-
name: BUGFIXES
labels:
- kind/bug
-
name: ENHANCEMENTS
labels:
- kind/enhancement
- kind/refactor
- kind/ui
-
name: TESTING
labels:
- kind/testing
-
name: TRANSLATION
labels:
- kind/translation
-
name: BUILD
labels:
- kind/build
- kind/lint
-
name: DOCS
labels:
- kind/docs
-
name: MISC
default: true

# regex indicating which labels to skip for the changelog
skip-labels: skip-changelog|backport\/.+

+ 121
- 0
CHANGELOG.md View File

@@ -0,0 +1,121 @@
# Changelog

This changelog goes through all the changes that have been made in each release
without substantial changes to our git log.

## [1.0.0](https://gitea.com/xorm/xorm/pulls?q=&type=all&state=closed&milestone=1242) - to be released

* BUGFIXES
* Fix mssql quote (#1535)
* Fix join table name quote bug (#1534)
* ENHANCEMENTS
* Move reserve words related files into dialects sub package (#1544)
* Merge core package back into the main repository and split into serval sub packages. (#1543)

## old changelog

* **v0.6.5**
* Postgres schema support
* vgo support
* Add FindAndCount
* Database special params support via NewEngineWithParams
* Some bugs fixed

* **v0.6.4**
* Automatical Read/Write seperatelly
* Query/QueryString/QueryInterface and action with Where/And
* Get support non-struct variables
* BufferSize on Iterate
* fix some other bugs.

* **v0.6.3**
* merge tests to main project
* add `Exist` function
* add `SumInt` function
* Mysql now support read and create column comment.
* fix time related bugs.
* fix some other bugs.

* **v0.6.2**
* refactor tag parse methods
* add Scan features to Get
* add QueryString method

* **v0.4.5**
* many bugs fixed
* extends support unlimited deep
* Delete Limit support

* **v0.4.4**
* ql database expriment support
* tidb database expriment support
* sql.NullString and etc. field support
* select ForUpdate support
* many bugs fixed

* **v0.4.3**
* Json column type support
* oracle expirement support
* bug fixed

* **v0.4.2**
* Transaction will auto rollback if not Rollback or Commit be called.
* Gonic Mapper support
* bug fixed

* **v0.4.1**
* deleted tag support for soft delete
* bug fixed

* **v0.4.0 RC1**
Changes:
* moved xorm cmd to [github.com/go-xorm/cmd](github.com/go-xorm/cmd)
* refactored general DB operation a core lib at [github.com/go-xorm/core](https://github.com/go-xorm/core)
* moved tests to github.com/go-xorm/tests [github.com/go-xorm/tests](github.com/go-xorm/tests)

Improvements:
* Prepared statement cache
* Add Incr API
* Specify Timezone Location

* **v0.3.2**
Improvements:
* Add AllCols & MustCols function
* Add TableName for custom table name

Bug Fixes:
* #46
* #51
* #53
* #89
* #86
* #92

* **v0.3.1**

Features:
* Support MSSQL DB via ODBC driver ([github.com/lunny/godbc](https://github.com/lunny/godbc));
* Composite Key, using multiple pk xorm tag
* Added Row() API as alternative to Iterate() API for traversing result set, provide similar usages to sql.Rows type
* ORM struct allowed declaration of pointer builtin type as members to allow null DB fields
* Before and After Event processors

Improvements:
* Allowed int/int32/int64/uint/uint32/uint64/string as Primary Key type
* Performance improvement for Get()/Find()/Iterate()


* **v0.2.3** : Improved documents; Optimistic Locking support; Timestamp with time zone support; Mapper change to tableMapper and columnMapper & added PrefixMapper & SuffixMapper support custom table or column name's prefix and suffix;Insert now return affected, err instead of id, err; Added UseBool & Distinct;
* **v0.2.2** : Postgres drivers now support lib/pq; Added method Iterate for record by record to handler;Added SetMaxConns(go1.2+) support; some bugs fixed.
* **v0.2.1** : Added database reverse tool, now support generate go & c++ codes, see [Xorm Tool README](https://github.com/go-xorm/xorm/blob/master/xorm/README.md); some bug fixed.
* **v0.2.0** : Added Cache supported, select is speeder up 3~5x; Added SameMapper for same name between struct and table; Added Sync method for auto added tables, columns, indexes;
* **v0.1.9** : Added postgres and mymysql supported; Added ` and ? supported on Raw SQL even if postgres; Added Cols, StoreEngine, Charset function, Added many column data type supported, please see [Mapping Rules](#mapping).
* **v0.1.8** : Added union index and union unique supported, please see [Mapping Rules](#mapping).
* **v0.1.7** : Added IConnectPool interface and NoneConnectPool, SysConnectPool, SimpleConnectPool the three implements. You can choose one of them and the default is SysConnectPool. You can customrize your own connection pool. struct Engine added Close method, It should be invoked before system exit.
* **v0.1.6** : Added conversion interface support; added struct derive support; added single mapping support
* **v0.1.5** : Added multi threads support; added Sql() function for struct query; Get function changed return inteface; MakeSession and Create are instead with NewSession and NewEngine.
* **v0.1.4** : Added simple cascade load support; added more data type supports.
* **v0.1.3** : Find function now supports both slice and map; Add Table function for multi tables and temperory tables support
* **v0.1.2** : Insert function now supports both struct and slice pointer parameters, batch inserting and auto transaction
* **v0.1.1** : Add Id, In functions and improved README
* **v0.1.0** : Initial release.

+ 41
- 0
CONTRIBUTING.md View File

@@ -22,6 +22,47 @@ e.g.,
// !lunny! this is comments made by lunny
```

### Build xorm and test it locally

Once you write some codes on your feature branch, you could build and test locally at first. Just

```
make build
```
and
```
make test
```

The `make test` is an alias of `make test-sqlite`, it will run the tests on a sqlite database file. No extra thing needed to do except you need to cgo compile enviroment.

If you write a new test method, you could run

```
make test-sqlite#TestMyNewMethod
```

that will only run the special test method.

If you want to run another datase, you have to prepare a running database at first, and then, you could

```
TEST_MYSQL_HOST= TEST_MYSQL_CHARSET= TEST_MYSQL_DBNAME= TEST_MYSQL_USERNAME= TEST_MYSQL_PASSWORD= make test-mysql
```

or other databases:
```
TEST_MSSQL_HOST= TEST_MSSQL_DBNAME= TEST_MSSQL_USERNAME= TEST_MSSQL_PASSWORD= make test-mssql
```
```
TEST_PGSQL_HOST= TEST_PGSQL_SCHEMA= TEST_PGSQL_DBNAME= TEST_PGSQL_USERNAME= TEST_PGSQL_PASSWORD= make test-postgres
```
```
TEST_TIDB_HOST= TEST_TIDB_DBNAME= TEST_TIDB_USERNAME= TEST_TIDB_PASSWORD= make test-tidb
```

And if your branch is related with cache, you could also enable it via `TEST_CACHE_ENABLE=true`.

### Patch review

Help review existing open [pull requests](https://help.github.com/articles/using-pull-requests) by commenting on the code or


Loading…
Cancel
Save