Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[V2 2623] update cli for new btr #8

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,28 @@ Use the same credentials you use to log into your [Volusion store admin](https:/

* * *

### `element new NAME`
### `element new NAME --git`

The command for scaffolding a new block. The command will clone the [Element Block Starter repo](https://github.com/volusion/element-blockstarter), allowing you to quickly get started with your development process.

You can use the optional `--git` flag to let git handle your block commits and major versions.

* * *

### `element publish --name "A NAME TO DISPLAY TO USERS" --category "OPTIONAL CATEGORY"`
### `element publish --name "A NAME TO DISPLAY TO USERS" --category "OPTIONAL CATEGORY" --new-major`

From the root directory of the block you intend to eventually make available to users of the Site Designer on the [Volusion store admin](https://admin.volusion.com).

Publishing your first block also will create a v1 branch to manage the version code base.

By default, _newly-published blocks will only be visible to you and the other members of your organization_.

In the event that a `-c/--category` flag is not passed, you will be prompted with a list of valid Category names from which to select.

If you pass `-m or --new-major` it will create a new major version for the block and a corresponding git branch.

_Protip_: `element publish -n "A NAME TO DISPLAY TO USERS" -c "OPTIONAL CATEGORY"`
_Protip_: `element publish -m`

* * *

Expand All @@ -60,6 +67,26 @@ _Protip_: `element update -p`

* * *

### `element release`

When you are ready to push your block live you can use this command.

### `element release --note "release note for the block`

There's only one optional flag for this command, and it's to add a release note to your block

_Protip_: `element update -n "release note for the block"`

* * *

### `element rollback`

If you have a problem with a release you can rollback to a previous release. The current release will be moved back to staging and the previous release will become active. If you rollback again it will remove the release from staging. You can continue to rollback until you only have your original release.

Each major version can be rolled back individually. However, you won't be able to rollback the inital published major version of the block.

* * *

### Adding a Thumbnail

Create a PNG file, ideally less than 100 kb in size, and save it in the root directory of the block as `thumbnail.png.` When publishing or updating your block, this file will be saved and then be shown in the Volusion store admin's [Site Designer](https://admin.volusion.com/designer).
Expand Down
3 changes: 2 additions & 1 deletion jest-unit.config.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"moduleFileExtensions": [
"ts",
"js"
"js",
"json"
],
"moduleDirectories": [
"node_modules",
Expand Down