Skip to content

Commit 0a103b1

Browse files
update docs in md files
1 parent 852e678 commit 0a103b1

File tree

3 files changed

+10
-66
lines changed

3 files changed

+10
-66
lines changed
Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
# Integration tests
22

3-
These integration tests are intended to ensure that the tool can interact with the real databases. Technically, it uses the Docker engine to run Databases, so you should install the Docker first. On Windows, I recommend using the Docker Desktop over the WSL 2. You can find a manual in the [Docker Docuntation](https://docs.docker.com/docker-for-windows/wsl/).
3+
These integration tests are intended to ensure that the tool can interact with the real databases. Technically, it uses the Docker engine to run Databases, so you should install the Docker first.
44

5-
Each test creates and runs a container with a database engine, then runs test, stops and remove the container. So, before running a test, you should download a container manually. For example:
6-
7-
```
8-
docker pull mcr.microsoft.com/mssql/server:2017-CU12-ubuntu
9-
```
10-
11-
You can find an appropriate command in the corresponding test code.
5+
Each test fixture creates a container for the given database engine. Each test runs against a different database within the container.
Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,7 @@
11
# How to create a new release
22

3-
1. Open Project Properties and update a version, release notes, tags and so on
4-
1. Build a NuGet-package
5-
* Open a console
6-
* Go to the `src\dbup-cli` folder
7-
* Run `dotnet pack -c Release`
8-
1. Build a .NetFramework 4.6 standalone utility
9-
* Run `dotnet build -c Release -p:GlobalTool=false`
10-
* Update `/build/PackDbUp.cmd` if needed
11-
* Pack the utility to a single exe-file: go to the `build` folder and run `PackDbUp.cmd`. See the `build/readme.md` for additional instructions
12-
1. Update Release Notes on the project main [README](https://github.com/drwatson1/dbup-cli/blob/master/README.md) page.
13-
1. Update Wiki-pages if needed
14-
1. Publish NuGet-package. Don't remember to add additional documentation from the main [README](https://github.com/drwatson1/dbup-cli/blob/master/README.md) page.
15-
1. Commit and push all changes
16-
1. Merge the branch to the master
17-
1. Create a new release on GitHub. Don't remember to add the standalone utility for .NetFramework 4.6.2 from `build` folder and the NuGet-package
3+
1. Push a semver tag to github repository. eg. v2.0.0 or v2.0.0-beta
4+
1. GitHub actions will
5+
- generate and publish the nuget package
6+
- create a draft GitHub release associated with the tag
7+
1. In GitHub, add any additionally useful release notes and publish the release.

src/dbup-cli/ROADMAP.md

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,15 @@
1-
# Road map for v.1.0
2-
3-
## Features to implement
4-
5-
[x] Implement option MarkAsExecuted for upgrade command to mark scrips as executed without actual execution of the scripts
6-
[x] Support input encoding of script files
7-
[x] Script filters
8-
[x] Wildcards
9-
[x] Regex
1+
This is a trimmed list from the original repo. Keeping here until I can evaluate and rehome the tasks to take on.
102

113
## TODO List
124

135
[ ] dbup init -> display information about successful file creation
14-
[ ] dbup status -x -n -> remove redundunt empty line
15-
[x] dbup status --show-executed -> brief option alias can't be -e because it is already used by --env (-e) option
6+
[ ] dbup status -x -n -> remove redundant empty line
167
[ ] subFolders: yes -> Displays strange scripts' names: e.g. subfolder.005.sql
17-
[x] Move logToConsole and logScriptOutput options to command line from a configuration file
188

19-
## Other stuff
9+
## Considerations
2010

21-
[x] Create test for default dbup.yml file
22-
[x] Check the existence of script folder
23-
[x] Check a version of a config file
24-
[x] Target the project as a tool
25-
[x] Publish an alpha version to NuGet.org and do some tests with it
26-
[ ] Add CI (travis or appveyor)
27-
[ ] Add CD (travis or appveyor) - publish NuGet
28-
[x] Getting started page
29-
[x] Wiki documentation
30-
[x] Start page
31-
[x] Publish version 1.0
32-
[ ] Create a TFS pipeline task
33-
[ ] Wiki documentation/getting started for the TFS task
3411
[ ] Publish the extension to the marketplace
35-
[ ] Add CI (travis or appveyor) - TFS Task
36-
[ ] Add CD (travis or appveyor) - TFS Task - publish to the marketplace
37-
38-
## Future plans
39-
40-
v.1.1
41-
42-
[x] Support of PostgreSql
43-
44-
v.1.3
45-
46-
[x] Support of MySql
47-
48-
v.Next
49-
5012
[ ] Drop database for PostgreSQL and MySQL
5113
[ ] Backup a database
5214
[ ] Automatic backup a database before upgrade
5315
[ ] Support of Sqlite
54-
[ ] Build with .Net Core 3.1
55-
[ ] Automate build and release

0 commit comments

Comments
 (0)