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

Rename "connect-client" to "publishing-client" #212

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .github/workflows/main.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ jobs:
build-args: BUILDKIT_INLINE_CACHE=1
pull: True
file: build/package/Dockerfile
tags: rstudio/connect-client:latest
tags: rstudio/publishing-client:latest
outputs: type=docker,dest=/tmp/build-image.tar
-
if: ${{ steps.cache-docker-image-restore.outputs.cache-hit != 'true' }}
Expand Down Expand Up @@ -309,7 +309,7 @@ jobs:
-
name: Make agents executable
run: |
sudo chmod -R +x ./bin/**/connect-client
sudo chmod -R +x ./bin/**/publishing-client
-
name: Agent build artifacts
uses: actions/upload-artifact@v3
Expand Down Expand Up @@ -353,7 +353,7 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Restore Cache UX node_modules
id: node_modules
Expand Down Expand Up @@ -389,7 +389,7 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Run Windows CLI Tests
env:
Expand All @@ -401,7 +401,7 @@ jobs:
run: |
just test/bats-install
$env:Path += ";$env:GITHUB_WORKSPACE\test\libs\bats-core\bin"
$env:BINARY_PATH = "$env:GITHUB_WORKSPACE\bin\windows-amd64\connect-client"
$env:BINARY_PATH = "$env:GITHUB_WORKSPACE\bin\windows-amd64\publishing-client"
cd $env:GITHUB_WORKSPACE\test
just run-client $env:os
-
Expand Down Expand Up @@ -434,14 +434,14 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Run MacOs CLI Tests
env:
os: macos-latest
BATS_SUPPORT_LIB: ${{ github.workspace }}/test/libs/bats-support/load
BATS_ASSERT_LIB: ${{ github.workspace }}/test/libs/bats-assert/load
BINARY_PATH: ${{ github.workspace }}/bin/darwin-amd64/connect-client
BINARY_PATH: ${{ github.workspace }}/bin/darwin-amd64/publishing-client
# WARNING Docker run will only fail step if last command fails...
run: |
just test/bats-install
Expand Down Expand Up @@ -502,7 +502,7 @@ jobs:
pull: True
file: test/docker/Dockerfile
platforms: linux/amd64
tags: rstudio/connect-client-linux-amd64:latest
tags: rstudio/publishing-client-linux-amd64:latest
outputs: type=docker,dest=/tmp/linux-amd64-image.tar
-
if: ${{ steps.cache-linux-amd64-restore.outputs.cache-hit != 'true' }}
Expand Down Expand Up @@ -539,7 +539,7 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Cache docker image (restore)
id: cache-linux-amd64-image
Expand Down Expand Up @@ -613,7 +613,7 @@ jobs:
pull: True
file: test/docker/Dockerfile
platforms: linux/arm64
tags: rstudio/connect-client-linux-arm64:latest
tags: rstudio/publishing-client-linux-arm64:latest
outputs: type=docker,dest=/tmp/linux-arm64-image.tar
-
if: ${{ steps.cache-linux-arm64-restore.outputs.cache-hit != 'true' }}
Expand Down Expand Up @@ -650,7 +650,7 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client

# these are required to run docker on amd64 and arm64 platforms
-
Expand Down
50 changes: 25 additions & 25 deletions .github/workflows/pull-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
id: cache-docker-image-restore
uses: actions/cache/restore@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('build/package/Dockerfile') }}
Expand All @@ -54,15 +54,15 @@ jobs:
build-args: BUILDKIT_INLINE_CACHE=1
pull: True
file: build/package/Dockerfile
tags: rstudio/connect-client:latest
tags: rstudio/publishing-client:latest
outputs: type=docker,dest=/tmp/build-image.tar
-
if: ${{ steps.cache-docker-image-restore.outputs.cache-hit != 'true' }}
name: Cache docker image (update)
id: cache-docker-image-save
uses: actions/cache/save@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('build/package/Dockerfile') }}
Expand All @@ -86,7 +86,7 @@ jobs:
id: cache-docker-image
uses: actions/cache/restore@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('/tmp/build-image.tar') }}
Expand Down Expand Up @@ -148,7 +148,7 @@ jobs:
id: cache-docker-image
uses: actions/cache/restore@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('/tmp/build-image.tar') }}
Expand Down Expand Up @@ -196,7 +196,7 @@ jobs:
id: cache-docker-image
uses: actions/cache/restore@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('/tmp/build-image.tar') }}
Expand Down Expand Up @@ -247,7 +247,7 @@ jobs:
id: cache-docker-image
uses: actions/cache/restore@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('/tmp/build-image.tar') }}
Expand Down Expand Up @@ -285,7 +285,7 @@ jobs:
id: cache-docker-image
uses: actions/cache/restore@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('/tmp/build-image.tar') }}
Expand All @@ -306,7 +306,7 @@ jobs:
-
name: Make agents executable
run: |
sudo chmod -R +x ./bin/**/connect-client
sudo chmod -R +x ./bin/**/publishing-client
-
name: Agent build artifacts
uses: actions/upload-artifact@v3
Expand All @@ -333,7 +333,7 @@ jobs:
id: cache-docker-image
uses: actions/cache/restore@v3
env:
cache-name: cache-docker-image
cache-name: cached-image
with:
path: /tmp/build-image.tar
key: ${{ runner.os }}-docker-image-${{ env.cache-name }}-${{ hashFiles('/tmp/build-image.tar') }}
Expand All @@ -350,7 +350,7 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Restore Cache UX node_modules
id: node_modules
Expand Down Expand Up @@ -386,7 +386,7 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Run Windows CLI Tests
env:
Expand All @@ -398,7 +398,7 @@ jobs:
run: |
just test/bats-install
$env:Path += ";$env:GITHUB_WORKSPACE\test\libs\bats-core\bin"
$env:BINARY_PATH = "$env:GITHUB_WORKSPACE\bin\windows-amd64\connect-client"
$env:BINARY_PATH = "$env:GITHUB_WORKSPACE\bin\windows-amd64\publishing-client"
cd $env:GITHUB_WORKSPACE\test
just run-client $env:os
-
Expand Down Expand Up @@ -431,14 +431,14 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Run MacOs CLI Tests
env:
os: macos-latest
BATS_SUPPORT_LIB: ${{ github.workspace }}/test/libs/bats-support/load
BATS_ASSERT_LIB: ${{ github.workspace }}/test/libs/bats-assert/load
BINARY_PATH: ${{ github.workspace }}/bin/darwin-amd64/connect-client
BINARY_PATH: ${{ github.workspace }}/bin/darwin-amd64/publishing-client
# WARNING Docker run will only fail step if last command fails...
run: |
just test/bats-install
Expand Down Expand Up @@ -485,7 +485,7 @@ jobs:
path: /tmp/linux-amd64-image.tar
key: ${{ env.cache-name }}-${{ hashFiles('test/docker/Dockerfile') }}
env:
cache-name: cache-linux-amd64-image
cache-name: cached-linux-amd64-image
os: linux-amd64
-
if: ${{ steps.cache-linux-amd64-restore.outputs.cache-hit != 'true' }}
Expand All @@ -499,15 +499,15 @@ jobs:
pull: True
file: test/docker/Dockerfile
platforms: linux/amd64
tags: rstudio/connect-client-linux-amd64:latest
tags: rstudio/publishing-client-linux-amd64:latest
outputs: type=docker,dest=/tmp/linux-amd64-image.tar
-
if: ${{ steps.cache-linux-amd64-restore.outputs.cache-hit != 'true' }}
name: Cache docker image (update)
id: cache-linux-amd64-image-save
uses: actions/cache/save@v3
env:
cache-name: cache-linux-amd64-image
cache-name: cached-linux-amd64-image
with:
path: /tmp/linux-amd64-image.tar
key: ${{ env.cache-name }}-${{ hashFiles('test/docker/Dockerfile') }}
Expand Down Expand Up @@ -536,13 +536,13 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client
-
name: Cache docker image (restore)
id: cache-linux-amd64-image
uses: actions/cache/restore@v3
env:
cache-name: cache-linux-amd64-image
cache-name: cached-linux-amd64-image
with:
path: /tmp/linux-amd64-image.tar
key: ${{ env.cache-name }}-${{ hashFiles('test/docker/Dockerfile') }}
Expand Down Expand Up @@ -596,7 +596,7 @@ jobs:
path: /tmp/linux-arm64-image.tar
key: ${{ env.cache-name }}-${{ hashFiles('test/docker/Dockerfile') }}
env:
cache-name: cache-linux-arm64-image
cache-name: cached-linux-arm64-image
os: linux-arm64
-
if: ${{ steps.cache-linux-arm64-restore.outputs.cache-hit != 'true' }}
Expand All @@ -610,15 +610,15 @@ jobs:
pull: True
file: test/docker/Dockerfile
platforms: linux/arm64
tags: rstudio/connect-client-linux-arm64:latest
tags: rstudio/publishing-client-linux-arm64:latest
outputs: type=docker,dest=/tmp/linux-arm64-image.tar
-
if: ${{ steps.cache-linux-arm64-restore.outputs.cache-hit != 'true' }}
name: Cache docker image (update)
id: cache-linux-arm64-image-save
uses: actions/cache/save@v3
env:
cache-name: cache-linux-arm64-image
cache-name: cached-linux-arm64-image
with:
path: /tmp/linux-arm64-image.tar
key: ${{ env.cache-name }}-${{ hashFiles('test/docker/Dockerfile') }}
Expand Down Expand Up @@ -647,7 +647,7 @@ jobs:
-
name: Make agents executable
run: |
chmod -R +x ./bin/**/connect-client
chmod -R +x ./bin/**/publishing-client

# these are required to run docker on amd64 and arm64 platforms
-
Expand All @@ -663,7 +663,7 @@ jobs:
id: cache-linux-arm64-image
uses: actions/cache/restore@v3
env:
cache-name: cache-linux-arm64-image
cache-name: cached-linux-arm64-image
with:
path: /tmp/linux-arm64-image.tar
key: ${{ env.cache-name }}-${{ hashFiles('test/docker/Dockerfile') }}
Expand Down
4 changes: 2 additions & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"type": "go",
"request": "launch",
"mode": "auto",
"program": "cmd/connect-client/main.go",
"program": "cmd/publishing-client/main.go",
"args": [
"publish-ui",
"-n",
Expand All @@ -22,7 +22,7 @@
"type": "go",
"request": "launch",
"mode": "auto",
"program": "cmd/connect-client/main.go",
"program": "cmd/publishing-client/main.go",
"args": [
"publish",
"-n",
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ your local machine for development and testing purposes.
### Prerequisites

NOTE: This project has been configured to use docker by default, which minimizes
the prerequisites which need to be installed. Use of docker can be controlled
the prerequisites which need to be installed. Use of docker can be controlled
via the DOCKER environment variable:
if (DOCKER is undefined || DOCKER === 'true') {
Tasks will be executed in a docker container using the image `build/package/Dockerfile`
Expand All @@ -25,7 +25,7 @@ If using Docker, you must have Docker installed: [Docker](https://www.docker.com

Just (justfile runner) is used to run commands: [Just](https://just.systems)

See the additional pre-requisites required for development tasks without Docker at:
See the additional pre-requisites required for development tasks without Docker at:
- CLI: TBD
- UX: [`web/README.md`](./web/README.md)

Expand All @@ -49,16 +49,16 @@ Simplest approach to perform all of the applicable steps:

Building the DOCKER image:
- If using docker (by either not setting the DOCKER environment variable or setting it to "true"), you'll need
to build the DOCKER image. This is done as one of the steps within the `default` recipe, but you can also
to build the DOCKER image. This is done as one of the steps within the `default` recipe, but you can also
perform it with the command `just image`.
- If you are not using docker, you can skip this step, although performing the recipe is a NO-OP.

#### Justfiles

All tasks are done through the justfile recipes, present within the top level `justfile` file. Recipes present include macro-operations
for the multiple projects (Go and Web SPA) included in this repo.
for the multiple projects (Go and Web SPA) included in this repo.

Specialized recipes for the Go project are located within the `cmd/connect-client/justfile` and
Specialized recipes for the Go project are located within the `cmd/publishing-client/justfile` and
specialized recipes for the Web project are located within the `web/justfile`.

The top level `justfile` recipes can be displayed from within the top level repo subdirectory by issuing the command: `just --list`
Expand All @@ -72,8 +72,8 @@ If you want to build the development version the easiest (after switching branch
1. Build and start the vite web server, to support error reporting and hot-reloading: `just web/dev` in one terminal. Keep the terminal window open.
- This will launch the `vite` web server on `http://127.0.0.1:9000`
2. Within a new terminal window, build the development version of the CLI: `just build-dev`. Keep this terminal open, so that you can rebuild as needed.
3. Within a new terminal window, launch the development version of the CLI for the current platform (with these parameters): `./connect-client publish-ui <PROJECT_PATH> --listen=127.0.0.1:9001 --open-browser-at="http://127.0.0.1:9000" --skip-browser-session-auth`
- *Where** `<PROJECT_PATH>` above is replaced with a location of a sample project. For example, with a python project at `~/dev/connect-content/bundles/python-flaskapi`, your complete command line would become: `./connect-client publish-ui ~/dev/connect-content/bundles/python-flaskapi --listen=127.0.0.1:9001 --open-browser-at="http://127.0.0.1:9000" --skip-browser-session-auth`.
3. Within a new terminal window, launch the development version of the CLI for the current platform (with these parameters): `./publishing-client publish-ui <PROJECT_PATH> --listen=127.0.0.1:9001 --open-browser-at="http://127.0.0.1:9000" --skip-browser-session-auth`
- *Where** `<PROJECT_PATH>` above is replaced with a location of a sample project. For example, with a python project at `~/dev/connect-content/bundles/python-flaskapi`, your complete command line would become: `./publishing-client publish-ui ~/dev/connect-content/bundles/python-flaskapi --listen=127.0.0.1:9001 --open-browser-at="http://127.0.0.1:9000" --skip-browser-session-auth`.
- This launches the CLI and configures it to listen on port `9001`, while launching a browser to the address which is being served by the `vite` web server.

You now should have a Web UX loaded within the browser, which is loading from the `vite` dev server, but has its APIs serviced from the CLI backend.
Expand Down
Loading