From 27ad753bb8dfb62b4ad663811e85861721b5826e Mon Sep 17 00:00:00 2001 From: Dan Buch Date: Fri, 26 Jun 2020 17:44:23 -0400 Subject: [PATCH] Update changelog in prep for 1.5.0 release and include it in the generated docs, plus remove redundant content of CONTRIBUTING while cleaning up Connected to rstudio/connect#17604 --- .gitignore | 1 + CHANGELOG.md | 120 ++++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING | 47 ------------------- NEWS.md | 85 ---------------------------------- docs/Makefile | 6 ++- docs/mkdocs.yml | 1 + 6 files changed, 126 insertions(+), 134 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 CONTRIBUTING delete mode 100644 NEWS.md diff --git a/.gitignore b/.gitignore index 336fb6d2..aa451225 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ htmlcov /tests/testdata/**/rsconnect-python/ /docs/docs/index.md +/docs/docs/changelog.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..44fa4129 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,120 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +### Changed +### Deprecated +### Removed +### Fixed +### Security + +## [1.5.0] - 2020-TBD + +### Added +- support for deploying Streamlit and Bokeh applications +- improved handling of HTTP timeouts +- CI verification on macos with python3.8 +- trigger [rsconnect-jupyter](https://github.com/rstudio/rsconnect-jupyter) workflow on + successful pushes to main branch + +### Changed +- default exclusion list to include common virtual environment directory names (`env`, + `venv`, `.env`, and `.venv`) +- environment internally represented as data class instead of dict +- replace all internal "compatibility mode" references with "conda mode" +- CI moved to GitHub Actions + +### Removed +- generation and publishing of `sdist` artifact + +### Fixed +- explicitly set the `--to-html` option to `nbconvert` when publishing a static notebook, + as required by the latest version of `nbconvert` + + +## [1.4.5] - 2020-04-10 + +### Changed +- provide clearer feedback when errors happen while building bundles from a manifest +- pin required versions of the `click` and `six` libraries that we use +- help text touch up + +### Fixed +- output alignment under Python 2 + + +## [1.4.4] - 2020-04-02 + +### Changed +- converted a traceback to a more appropriate message +- updated `CookieJar` class to support marshalling/un-marshalling + to/from a dictionary + +### Fixed +- an issue with cookie jar continuity across connections + + +## [1.4.3] - 2020-04-01 + +### Changed +- being more distinguishing between a server that's not running Connect and a credentials + problem + + +## [1.4.2] - 2020-03-27 + +### Added +- more helpful feedback when a "requested object does not exist" error is returned by + Connect + +### Changed +- be more distinguishing between a server that's not running Connect and a credentials + problem + +### Fixed +- an issue where cookie header size could grow inappropriately (#107) +- corrected the instructions to enable auto-completion + + +## [1.4.1] - 2020-03-26 + +### Fixed +- sticky sessions so we will track deploys correctly when RStudio Connect is in an + HA/clustered environment + + +## [1.4.0] - 2020-03-16 + +### Added +- functions in `actions` that provide the same functionality as the CLI + +### Changed +- command line handling of options is more consistent across all commands +- `test` command replaced with a more broadly functional `details` command +- errors handled much more consistently and are more informative +- CLI output is more clean +- overall code has been refactored and improved for clarity, testability and stability +- all CLI help has been improved for consistency, correctness and completeness +- many documentation improvements in content and appearance + + +## [1.3.0] - 2020-01-07 + +### Added +- first release + + +[Unreleased]: https://github.com/rstudio/rsconnect-python/compare/1.5.0...HEAD +[1.5.0]: https://github.com/rstudio/rsconnect-python/compare/1.4.5...1.5.0 +[1.4.5]: https://github.com/rstudio/rsconnect-python/compare/1.4.4...1.4.5 +[1.4.4]: https://github.com/rstudio/rsconnect-python/compare/1.4.3...1.4.4 +[1.4.3]: https://github.com/rstudio/rsconnect-python/compare/1.4.2...1.4.3 +[1.4.2]: https://github.com/rstudio/rsconnect-python/compare/1.4.1...1.4.2 +[1.4.1]: https://github.com/rstudio/rsconnect-python/compare/1.4.0...1.4.1 +[1.4.0]: https://github.com/rstudio/rsconnect-python/compare/1.3.0...1.4.0 +[1.3.0]: https://github.com/rstudio/rsconnect-python/releases/tag/1.3.0 diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index c72032d0..00000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,47 +0,0 @@ -# User Guide - -Installation and usage instructions are available -[here](https://github.com/rstudio/rsconnect-python/tree/master/README.md). - -# Developing `rsconnect-python` - -Docker images are used to run tests in. Use, - -```bash - make image- -``` - -where `python-version` is the version of Python you wish to test with. - -```bash - make all-images -``` - -will make images for the `2.7`, `3.5`, `3.6`, `3.7` and `3.8` versions of -Python. - -Use, - -```bash - make shell- -``` - -will place you in `bash` in a Docker container using the specified version of -Python. - -Use, - -```bash - make test- -``` - -will execute tests in a Docker container using the specified Python version. -You can use the `all-tests` target to run the tests under all the above Python -versions. - -# Packaging - -The following will create a universal [wheel](https://pythonwheels.com/) ready -to be installed in any python 2 or python 3 environment. - - make dist diff --git a/NEWS.md b/NEWS.md deleted file mode 100644 index d76b416c..00000000 --- a/NEWS.md +++ /dev/null @@ -1,85 +0,0 @@ -Development version --------------------------------------------------------------------------------- -* Added support for deploying Streamlit and Bokeh applications. - -* Expanded the default exclusion list to include common virtual environment - directory names (`env`, `venv`, `.env`, and `.venv`). - -* Improved handling of HTTP timeouts. - -* Added the `--to-html` option to `nbconvert` when publishing a static notebook. - This is required by the latest version of `nbconvert`. - - -`rsconnect-python` 1.4.5 --------------------------------------------------------------------------------- -* Provide clearer feedback when errors happen while building bundles from a - manifest. - -* Fix output alignment under Python 2. - -* Pin required versions of the `click` and `six` libraries that we use. - -* Help text touch up. - - -`rsconnect-python` 1.4.4 --------------------------------------------------------------------------------- -* Converted a traceback to a more appropriate message. - -* Updated our `CookieJar` class to support marshalling/un-marshalling to/from - a dictionary. - -* Corrected an issue with cookie jar continuity across connections. - - -`rsconnect-python` 1.4.3 --------------------------------------------------------------------------------- -* Finished being more distinguishing between a server that's not running Connect - and a credentials problem. - - -`rsconnect-python` 1.4.2 --------------------------------------------------------------------------------- -* Added more helpful feedback when a "requested object does not exist" error is - returned by Connect. - -* Fixed an issue where cookie header size could grow inappropriately (#107). - -* Be more distinguishing between a server that's not running Connect and a - credentials problem. - -* Corrected the instructions to enable auto-completion. - - -`rsconnect-python` 1.4.1 --------------------------------------------------------------------------------- -* Fixed sticky sessions so we will track deploys correctly when RStudio Connect - is in an HA/clustered environment. - - -`rsconnect-python` 1.4.0 --------------------------------------------------------------------------------- -* Command line handling of options is more consistent across all commands. - -* The `test` command has been replaced with a more broadly functional `details` - command. - -* There are now functions in `actions` that provide the same functionality as the - CLI. - -* Errors are now handled much more consistently and are more informative. - -* CLI output is more clean. - -* The overall code has been refactored and improved for clarity, testability and - stability. - -* All CLI help has been improved for consistency, correctness and completeness. - -* Many documentation improvements in content and appearance. - - -`rsconnect-python` 1.3.0 --------------------------------------------------------------------------------- -* First release diff --git a/docs/Makefile b/docs/Makefile index 9f276c68..4ebc2e5c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -27,9 +27,11 @@ image: docker build -t $(MKDOCS_IMAGE) . .PHONY: build -build: docs/index.md +build: docs/index.md docs/changelog.md $(BUILD_RUNNER) mkdocs build - @rm docs/index.md docs/index.md: $(CURDIR)/../README.md python3 patch_admonitions.py + +docs/changelog.md: $(CURDIR)/../CHANGELOG.md + cp -v $^ $@ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index f571f44c..d1eaae99 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -19,6 +19,7 @@ plugins: nav: - index.md - API: mkapi/api/rsconnect + - changelog.md theme: name: material