Skip to content

Commit e641d19

Browse files
committed
Update changelog
1 parent 43b49df commit e641d19

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

CHANGELOG.md

+65
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,71 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [Unreleased]
8+
9+
### Added
10+
- Added `deploy voila` command to deploy Jupyter Voila notebooks.
11+
12+
### Changed
13+
- `deploy html` was refactored. Its behavior is described below.
14+
15+
### deploy html
16+
- specifying a directory in the path will result in that entire directory*, subdirectories, and sub contents included in the deploy bundle
17+
- the entire directory is included whether or not an entrypoint was supplied
18+
19+
20+
21+
e.g.
22+
using the following directory,
23+
```
24+
├─ my_project/
25+
│ ├─ index.html
26+
│ ├─ second.html
27+
```
28+
and the following command:
29+
```
30+
rsconnect deploy html -n local my_project
31+
```
32+
or this command:
33+
```
34+
rsconnect deploy html -n local my_project -e my_project/index.html
35+
```
36+
we will have a bundle which includes both `index.html` and `second.html`
37+
38+
- specifying a file in the path will result in that file* - not the entire directory - included in the deploy bundle
39+
40+
e.g.
41+
using the following directory,
42+
```
43+
├─ my_project/
44+
│ ├─ index.html
45+
│ ├─ second.html
46+
```
47+
and the following command:
48+
```
49+
rsconnect deploy html -n local my_project/second.html
50+
```
51+
we will have a bundle which includes `second.html`
52+
53+
- a note regarding entrypiont
54+
- providing an entrypoint is optional if there's an `index.html` inside the project directory, or if there's a *single* html file in the project directory.
55+
- if there are multiple html files in the project directory and it contains no `index.html`, we will get an exception when deploying that directory unless an entrypoint is specified.
56+
57+
- if we want to specify an entrypint, and we are executing the deploy command outside a project folder, we must specify the full path of the entrypoint:
58+
59+
```
60+
rsconnect deploy html -n local my_project -e my_project/second.html
61+
```
62+
63+
- if we want to specify an entrypint, and we are executing the deploy command inside the project folder, we can abbreviate the entrypoint, like so:
64+
```
65+
cd my_project
66+
rsconnect deploy html -n local ./ -e second.html
67+
```
68+
69+
70+
*Plus the manifest & other necessary files needed for the bundle to work on Connect.
71+
772
## [1.14.1] - 2023-02-09
873

974
### Fixed

0 commit comments

Comments
 (0)