Skip to content

Commit 867a13a

Browse files
camilamaiacamilamaia
committed
Update CHANGELOG and bumped candidate release
1 parent bc7babf commit 867a13a

2 files changed

Lines changed: 75 additions & 73 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 74 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -8,160 +8,162 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
## [Unreleased]
99
### Added
1010
- JSON response is now properly rendered, instead of plain text. [#213](https://github.com/scanapi/scanapi/pull/213)
11-
- The report page now has a favicon [#223](https://github.com/scanapi/scanapi/pull/223)
12-
- Bandit security audit tool [#219](https://github.com/scanapi/scanapi/pull/219)
13-
- Add Sphinx auto-documentation [#230](https://github.com/scanapi/scanapi/pull/230)
14-
- Add workflow to package/publish to Test PyPi [#239](https://github.com/scanapi/scanapi/pull/239)
11+
- The report page now has a favicon. [#223](https://github.com/scanapi/scanapi/pull/223)
12+
- Bandit security audit tool. [#219](https://github.com/scanapi/scanapi/pull/219)
13+
- Add Sphinx auto-documentation. [#230](https://github.com/scanapi/scanapi/pull/230)
14+
- Add workflow to package/publish to Test PyPi. [#239](https://github.com/scanapi/scanapi/pull/239)
1515

1616
### Changed
17-
- Renamed `api.(yaml|json)` to `scanapi.yaml` [#222](https://github.com/scanapi/scanapi/issues/20://github.com/scanapi/scanapi/pull/222)
17+
- Renamed `api.(yaml|json)` to `scanapi.yaml`. [#222](https://github.com/scanapi/scanapi/issues/20://github.com/scanapi/scanapi/pull/222)
1818
- Remove top-level `api` key in `scanapi.yaml`. [#231](https://github.com/scanapi/scanapi/pull/231)
1919
- Renamed `project-name`, `hide-request` and `hide-response` to use underscore. [#228](https://github.com/scanapi/scanapi/issues/228)
2020
- Changed command `scanapi spec-file.yaml` to `scanapi run spec-file.yaml`. [#247](https://github.com/scanapi/scanapi/pull/247)
21-
- Moved Documentation from README.md to the website [#250](https://github.com/scanapi/scanapi/pull/250)
22-
- Global configuration.
21+
- Moved Documentation from README.md to the website. [#250](https://github.com/scanapi/scanapi/pull/250)
22+
- Local and global configuration. [#254](https://github.com/scanapi/scanapi/pull/254)
2323

2424
### Fixed
25-
- Updated language use in README.md and CONTRIBUTING.md plus fix broken links [#220](https://github.com/scanapi/scanapi/pull/220)
26-
- Removed unused sys import in scan.py and cleaned for PEP8 and spelling errors [#217](https://github.com/scanapi/scanapi/pull/217)
27-
- Hide body sensitive information [#238](https://github.com/scanapi/scanapi/pull/238)
25+
- Updated language use in README.md and CONTRIBUTING.md plus fix broken links. [#220](https://github.com/scanapi/scanapi/pull/220)
26+
- Removed unused sys import in scan.py and cleaned for PEP8 and spelling errors. [#217](https://github.com/scanapi/scanapi/pull/217)
27+
- Hide body sensitive information. [#238](https://github.com/scanapi/scanapi/pull/238)
2828

2929
### Removed
30-
- APIKeyMissingError [#218](https://github.com/scanapi/scanapi/pull/218)
30+
- APIKeyMissingError. [#218](https://github.com/scanapi/scanapi/pull/218)
3131

3232
## [1.0.5] - 2020-07-18
3333
### Fixed
34-
- Status icons on report were not vertically centered [#195](https://github.com/scanapi/scanapi/pull/195)
34+
- Status icons on report were not vertically centered. [#195](https://github.com/scanapi/scanapi/pull/195)
3535

3636
## [1.0.4] - 2020-06-25
3737

3838
## [1.0.3] - 2020-06-25
3939
### Added
40-
- MANIFEST.in
40+
- MANIFEST.in.
4141

4242
## [1.0.2] - 2020-06-25
4343
### Fixed
44-
- Fix for TemplateNotFound Error [#197](https://github.com/scanapi/scanapi/pull/197)
44+
- Fix for TemplateNotFound Error. [#197](https://github.com/scanapi/scanapi/pull/197)
4545

4646
## [1.0.1] - 2020-06-25
4747
### Fixed
48-
- Report example images not loading on PyPI [#193](https://github.com/scanapi/scanapi/pull/193)
48+
- Report example images not loading on PyPI. [#193](https://github.com/scanapi/scanapi/pull/193)
4949

5050
## [1.0.0] - 2020-06-25
5151
### Added
52-
- Add new HTML template [#157](https://github.com/scanapi/scanapi/pull/157)
53-
- Tests key [#152](https://github.com/scanapi/scanapi/pull/152)
54-
- `-h` alias for `--help` option [#172](https://github.com/scanapi/scanapi/pull/172)
55-
- Test results to report [#177](https://github.com/scanapi/scanapi/pull/177)
56-
- Add test errors to the report [#187](https://github.com/scanapi/scanapi/pull/187)
57-
- Hides sensitive info in URL [#185](https://github.com/scanapi/scanapi/pull/185)
58-
- CLI options explanation [#189](https://github.com/scanapi/scanapi/pull/189)
52+
- Add new HTML template. [#157](https://github.com/scanapi/scanapi/pull/157)
53+
- Tests key. [#152](https://github.com/scanapi/scanapi/pull/152)
54+
- `-h` alias for `--help` option. [#172](https://github.com/scanapi/scanapi/pull/172)
55+
- Test results to report. [#177](https://github.com/scanapi/scanapi/pull/177)
56+
- Add test errors to the report. [#187](https://github.com/scanapi/scanapi/pull/187)
57+
- Hides sensitive info in URL. [#185](https://github.com/scanapi/scanapi/pull/185)
58+
- CLI options explanation. [#189](https://github.com/scanapi/scanapi/pull/189)
5959

6060
### Changed
61-
- Unified keys validation in a single method [#151](https://github.com/scanapi/scanapi/pull/151)
62-
- Default template to html [#173](https://github.com/scanapi/scanapi/pull/173)
61+
- Unified keys validation in a single method. [#151](https://github.com/scanapi/scanapi/pull/151)
62+
- Default template to html. [#173](https://github.com/scanapi/scanapi/pull/173)
6363
- Project name color on html reporter to match ScanAPI brand [#172](https://github.com/scanapi/scanapi/pull/172)
64-
- Hero banner on README [#180](https://github.com/scanapi/scanapi/pull/180)
65-
- Entry point to `scanapi:main` [#172](https://github.com/scanapi/scanapi/pull/172)
66-
- `--spec-path` option to argument [#172](https://github.com/scanapi/scanapi/pull/172)
67-
- Improve test results on report [#186](https://github.com/scanapi/scanapi/pull/186)
68-
- Improve Error Message for Invalid Python code error [#187](https://github.com/scanapi/scanapi/pull/187)
69-
- Handle properly exit errors [#187](https://github.com/scanapi/scanapi/pull/187)
70-
- Update README.md [#191](https://github.com/scanapi/scanapi/pull/191)
64+
- Hero banner on README. [#180](https://github.com/scanapi/scanapi/pull/180)
65+
- Entry point to `scanapi:main`. [#172](https://github.com/scanapi/scanapi/pull/172)
66+
- `--spec-path` option to argument. [#172](https://github.com/scanapi/scanapi/pull/172)
67+
- Improve test results on report. [#186](https://github.com/scanapi/scanapi/pull/186)
68+
- Improve Error Message for Invalid Python code error. [#187](https://github.com/scanapi/scanapi/pull/187)
69+
- Handle properly exit errors. [#187](https://github.com/scanapi/scanapi/pull/187)
70+
- Update README.md. [#191](https://github.com/scanapi/scanapi/pull/191)
7171

7272
### Fixed
73-
- Duplicated status code row from report [#183](https://github.com/scanapi/scanapi/pull/183)
74-
- Sensitive information render on report [#183](https://github.com/scanapi/scanapi/pull/183)
73+
- Duplicated status code row from report. [#183](https://github.com/scanapi/scanapi/pull/183)
74+
- Sensitive information render on report. [#183](https://github.com/scanapi/scanapi/pull/183)
7575

7676
### Removed
77-
- Console Report [#175](https://github.com/scanapi/scanapi/pull/175)
78-
- Markdown Report [#179](https://github.com/scanapi/scanapi/pull/179)
79-
- `--reporter` option [#179](https://github.com/scanapi/scanapi/pull/179)
77+
- Console Report. [#175](https://github.com/scanapi/scanapi/pull/175)
78+
- Markdown Report. [#179](https://github.com/scanapi/scanapi/pull/179)
79+
- `--reporter` option. [#179](https://github.com/scanapi/scanapi/pull/179)
8080

8181
## [0.1.0] - 2020-05-14
8282
### Added
83-
- Automated pypi deploy - [#144](https://github.com/scanapi/scanapi/pull/144)
83+
- Automated pypi deploy. [#144](https://github.com/scanapi/scanapi/pull/144)
8484

8585
## [0.0.19] - 2020-05-11
8686
### Added
87-
- PATCH HTTP method - [#113](https://github.com/scanapi/scanapi/pull/113)
88-
- Ability to have API spec in multiples files - [#125](https://github.com/scanapi/scanapi/pull/125)
89-
- CLI `--config-path` option - [#128](https://github.com/scanapi/scanapi/pull/128)
90-
- CLI `--template-path` option - [#126](https://github.com/scanapi/scanapi/pull/126)
91-
- GitHub Action checking for missing changelog entry - [#134](https://github.com/scanapi/scanapi/pull/134)
87+
- PATCH HTTP method. [#113](https://github.com/scanapi/scanapi/pull/113)
88+
- Ability to have API spec in multiples files. [#125](https://github.com/scanapi/scanapi/pull/125)
89+
- CLI `--config-path` option. [#128](https://github.com/scanapi/scanapi/pull/128)
90+
- CLI `--template-path` option. [#126](https://github.com/scanapi/scanapi/pull/126)
91+
- GitHub Action checking for missing changelog entry. [#134](https://github.com/scanapi/scanapi/pull/134)
9292

9393
### Changed
94-
- Make markdown report a bit better - [#96](https://github.com/scanapi/scanapi/pull/96)
95-
- `base_url` keyword to `path` [#116](https://github.com/scanapi/scanapi/pull/116)
96-
- `namespace` keyword to `name` [#116](https://github.com/scanapi/scanapi/pull/116)
97-
- `method` keyword is not mandatory anymore for requests. Default is `get` [#116](https://github.com/scanapi/scanapi/pull/116)
98-
- Replaced `hide` key on report config by `hide-request` and `hide-response` [#116](https://github.com/scanapi/scanapi/pull/116)
99-
- Moved black check from CircleCI to github actions [#136](https://github.com/scanapi/scanapi/pull/136)
94+
- Make markdown report a bit better. [#96](https://github.com/scanapi/scanapi/pull/96)
95+
- `base_url` keyword to `path`. [#116](https://github.com/scanapi/scanapi/pull/116)
96+
- `namespace` keyword to `name`. [#116](https://github.com/scanapi/scanapi/pull/116)
97+
- `method` keyword is not mandatory anymore for requests. Default is `get`. [#116](https://github.com/scanapi/scanapi/pull/116)
98+
- Replaced `hide` key on report config by `hide-request` and `hide-response`. [#116](https://github.com/scanapi/scanapi/pull/116)
99+
- Moved black check from CircleCI to github actions. [#136](https://github.com/scanapi/scanapi/pull/136)
100100

101101
### Fixed
102-
- Cases where custom var has upper case letters [#99](https://github.com/scanapi/scanapi/pull/99)
102+
- Cases where custom var has upper case letters. [#99](https://github.com/scanapi/scanapi/pull/99)
103103

104104
### Removed
105-
- Request with no endpoints [#116](https://github.com/scanapi/scanapi/pull/116)
105+
- Request with no endpoints. [#116](https://github.com/scanapi/scanapi/pull/116)
106106

107107
## [0.0.18] - 2020-01-02
108108
### Changed
109-
- Return params/headers None when request doesn't have params/headers [#87](https://github.com/scanapi/scanapi/pull/87)
109+
- Return params/headers None when request doesn't have params/headers. [#87](https://github.com/scanapi/scanapi/pull/87)
110110

111111
### Fixed
112-
- Report-example image not loading on PyPi [#86](https://github.com/scanapi/scanapi/pull/86)
112+
- Report-example image not loading on PyPi. [#86](https://github.com/scanapi/scanapi/pull/86)
113113

114114
## [0.0.17] - 2019-12-19
115115
### Added
116-
- Added PyPI Test section to CONTRIBUTING.md
117-
- Added templates to pypi package - fix [#85](https://github.com/scanapi/scanapi/pull/85)
116+
- Added PyPI Test section to CONTRIBUTING.md.
117+
118+
### Fixed
119+
- Templates on pypi package. [#85](https://github.com/scanapi/scanapi/pull/85)
118120

119121
## [0.0.16] - 2019-12-18
120122
### Fixed
121-
- Fixed No module named 'scanapi.tree' [#83](https://github.com/scanapi/scanapi/pull/83)
123+
- Fixed No module named 'scanapi.tree'. [#83](https://github.com/scanapi/scanapi/pull/83)
122124

123125
## [0.0.15] - 2019-12-14
124126
### Added
125-
- CodeCov Setup
126-
- CircleCI Setup
127+
- CodeCov Setup.
128+
- CircleCI Setup.
127129

128130
### Changed
129-
- Updated Documentation
130-
- Increased coverage
131-
- Used dot notation to access responses inside api spec
132-
- Renamed option report_path to output_path
133-
- Reporter option -r, --reporter [console|markdown|html]
131+
- Updated Documentation.
132+
- Increased coverage.
133+
- Used dot notation to access responses inside api spec.
134+
- Renamed option report_path to output_path.
135+
- Reporter option -r, --reporter [console|markdown|html].
134136

135137
### Fixed
136-
- Fixed join of urls to keep the last slash
138+
- Fixed join of urls to keep the last slash.
137139

138140
### Removed
139-
- Removed requirements files and put every dependency under setup.py
140-
- Removed dcvars key
141+
- Removed requirements files and put every dependency under setup.py.
142+
- Removed dcvars key.
141143

142144
## [0.0.14] - 2019-10-09
143145
### Added
144-
- Add math, time, uuid and random libs to be used on api spec
146+
- Add math, time, uuid and random libs to be used on api spec.
145147

146148
## [0.0.13] - 2019-10-07
147149
### Changed
148-
- Bumped version
150+
- Bumped version.
149151

150152
## [0.0.12] - 2019-08-15
151153
### Added
152-
- Used env variables from os
154+
- Used env variables from os.
153155

154156
## [0.0.11] - 2019-08-09
155157
### Added
156-
- Added Docker file
158+
- Added Docker file.
157159

158160
## [0.0.10] - 2019-08-09
159161
### Added
160-
- Add logging
161-
- Option to hide headers fields
162+
- Add logging.
163+
- Option to hide headers fields.
162164

163165
### Fixed
164-
- Fix vars interpolation
166+
- Fix vars interpolation.
165167

166168
[Unreleased]: https://github.com/camilamaia/scanapi/compare/v1.0.5...HEAD
167169
[1.0.5]: https://github.com/camilamaia/scanapi/compare/v1.0.4...v1.0.5

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "scanapi"
3-
version = "1.0.5-rc.1"
3+
version = "1.0.5-rc.2"
44
description = "Automated Testing and Documentation for your REST API"
55
authors = ["Camila Maia <cmaiacd@gmail.com>"]
66
license = "MIT"

0 commit comments

Comments
 (0)