Merge pull request #97 from hashicorp/remove-build-references-to-connect-client
Remove build references to connect client
This commit is contained in:
43 files changed
+32
-27
No files matched your search
@@ -54,23 +54,28 @@ You will need the following things properly installed on your computer.
|
||||
|
||||
List of available project commands. `yarn run <command-name>`
|
||||
|
||||
| Command | Description |
|
||||
|---------------------|--------------------------------------------------------------------------------------------------------------------|
|
||||
| commit | Replaces `git commit`, ensures checks pass before commit is allowed and normalizes commit messages across authors. |
|
||||
| compliance:licenses | Checks that all dependencies have OSS-compatible licenses. |
|
||||
| doc:toc | Automatically generates a table of contents for the README file. |
|
||||
| Command | Description |
|
||||
|---------------------|---|
|
||||
| build | Builds Core UI. |
|
||||
| test | Runs tests in CI mode. |
|
||||
| commit | Replaces `git commit`, ensures compliance, audit, lint, and test checks pass before commit is allowed and normalizes commit messages across authors. |
|
||||
| lint | Runs ember-template-lint on all of the hbs, js, and sass files. |
|
||||
| compliance:audit | Checks for issues using `yarn audit` with moderate and above criticality.|
|
||||
| compliance:licenses | Checks that all dependencies have OSS-compatible licenses. |
|
||||
| doc:toc | Automatically generates a table of contents for the README file. |
|
||||
|
||||
## Contributing
|
||||
|
||||
### Branching
|
||||
|
||||
We follow [A Successful Git Branching Model][nvie-git], otherwise known as
|
||||
Gitflow. Branches `master` and `develop` are sacred mainlines into which we do
|
||||
Gitflow. Branches `main` and `develop` are sacred mainlines into which we do
|
||||
not commit directly. Instead, these branches have special meaning defining what
|
||||
code may be found within. The `develop` branch contains code _for the next
|
||||
release_. Code in `master` is _released, tagged, and ready for
|
||||
release_. Code in `main` is _released, tagged, and ready for
|
||||
production deployment_.
|
||||
|
||||
To start contributing:
|
||||
1. Start a new **topic branch** off `develop`.
|
||||
2. Commit work.
|
||||
3. When work is complete, create a PR from the topic branch into `develop`.
|
||||
@@ -80,20 +85,20 @@ production deployment_.
|
||||
5. A core team member may merge the PR into `develop`. At this point, the code
|
||||
is unreleased but considered "releasable".
|
||||
6. **Releasing**: when it's time to release, create a PR from `develop` into
|
||||
`master` (we skip Gitflow's `release` branch). This is tantamount to
|
||||
`main` (we skip Gitflow's `release` branch). This is tantamount to
|
||||
requesting a new release (version) of the product. Ensure the body of the PR
|
||||
includes well-documented changes slated for release.
|
||||
7. Code review and automated checks occur.
|
||||
8. A core team member may merge the PR into `master` to initiate a release.
|
||||
9. Tag the merge commit in `master` with version number of the release and cut
|
||||
8. A core team member may merge the PR into `main` to initiate a release.
|
||||
9. Tag the merge commit in `main` with version number of the release and cut
|
||||
a release in GitHub.
|
||||
|
||||
While Gitflow may seem heavy, most of its process can be automated. Gitflow is
|
||||
similar to its lighter-weight sibling [GitHub Flow][github-flow]. In essence,
|
||||
Gitflow differs only by adding an second mainline branch (`master`) that is
|
||||
Gitflow differs only by adding an second mainline branch (`main`) that is
|
||||
designated as _always containing production code_. Another happy characteristic
|
||||
of Gitflow is that it's easy to track the project's release history, since
|
||||
_every commit to `master` is a release by definition_. The well-defined nature
|
||||
_every commit to `main` is a release by definition_. The well-defined nature
|
||||
of releases assists in cross-team collaboration, ensuring everyone has
|
||||
confidence about the state of the project.
|
||||
|
||||
@@ -113,15 +118,14 @@ To quickly produce a production build of Core UI, run from this folder:
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
yarn build:ui:core
|
||||
yarn build
|
||||
```
|
||||
|
||||
Assets are saved to `ui/core/dist/`.
|
||||
|
||||
#### Building with a Container
|
||||
|
||||
Optionally, you may build the UI within a container. Execute the
|
||||
following command:
|
||||
Optionally, you may build the UI within a container. Execute the following command:
|
||||
|
||||
```bash
|
||||
docker-compose -f docker-compose-embedding.yml run build
|
||||
|
||||
+5
-4
@@ -16,20 +16,21 @@
|
||||
]
|
||||
},
|
||||
"scripts": {
|
||||
"build": "yarn build:ui:core",
|
||||
"build:ui:core": "cd ui/core && yarn build",
|
||||
"build:ui:connect-client": "cd ui/connect-client && yarn build",
|
||||
"lint": "yarn lint:addons:api && yarn lint:addons:auth && yarn lint:addons:rose && yarn lint:ui:core && yarn lint:ui:connect-client",
|
||||
"build:ui:desktop": "cd ui/desktop && yarn build",
|
||||
"lint": "yarn lint:addons:api && yarn lint:addons:auth && yarn lint:addons:rose && yarn lint:ui:core",
|
||||
"lint:addons:api": "echo \"\n\nlint: addons/api\n\" && cd addons/api && yarn lint",
|
||||
"lint:addons:auth": "echo \"\n\nlint: addons/auth\n\" && cd addons/auth && yarn lint",
|
||||
"lint:addons:rose": "echo \"\n\nlint: addons/rose\n\" && cd addons/rose && yarn lint",
|
||||
"lint:ui:core": "echo \"\n\nlint: ui/core\n\" && cd ui/core && yarn lint",
|
||||
"lint:ui:connect-client": "echo \"\n\nlint: ui/connect-client\n\" && cd ui/connect-client && yarn lint",
|
||||
"lint:ui:desktop": "echo \"\n\nlint: ui/desktop\n\" && cd ui/desktop && yarn lint",
|
||||
"test": "yarn test:addons:api && yarn test:addons:auth && yarn test:addons:rose && yarn test:ui:core",
|
||||
"test:addons:api": "echo \"\n\ntest: addons/api\n\" && cd addons/api && yarn test",
|
||||
"test:addons:auth": "echo \"\n\ntest: addons/auth\n\" && cd addons/auth && yarn test",
|
||||
"test:addons:rose": "echo \"\n\ntest: addons/rose\n\" && cd addons/rose && yarn test",
|
||||
"test:ui:core": "echo \"\n\ntest: ui/core\n\" && cd ui/core && yarn test",
|
||||
"test:ui:connect-client": "echo \"\n\ntest: ui/connect-client\n\" && cd ui/connect-client && yarn test",
|
||||
"test:ui:desktop": "echo \"\n\ntest: ui/desktop\n\" && cd ui/desktop && yarn test",
|
||||
"compliance:audit": "bash ./scripts/yarn-audit.sh",
|
||||
"precommit": "yarn compliance:licenses && yarn compliance:audit && yarn lint && yarn test",
|
||||
"commit": "git-cz",
|
||||
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -10,7 +10,7 @@
|
||||
{{content-for "head"}}
|
||||
|
||||
<link integrity="" rel="stylesheet" href="{{rootURL}}assets/vendor.css">
|
||||
<link integrity="" rel="stylesheet" href="{{rootURL}}assets/connect-client.css">
|
||||
<link integrity="" rel="stylesheet" href="{{rootURL}}assets/desktop.css">
|
||||
|
||||
{{content-for "head-footer"}}
|
||||
</head>
|
||||
@@ -18,7 +18,7 @@
|
||||
{{content-for "body"}}
|
||||
|
||||
<script src="{{rootURL}}assets/vendor.js"></script>
|
||||
<script src="{{rootURL}}assets/connect-client.js"></script>
|
||||
<script src="{{rootURL}}assets/desktop.js"></script>
|
||||
|
||||
{{content-for "body-footer"}}
|
||||
</body>
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -5,7 +5,7 @@ const API_HOST = process.env.API_HOST || '';
|
||||
|
||||
module.exports = function (environment) {
|
||||
let ENV = {
|
||||
modulePrefix: 'connect-client',
|
||||
modulePrefix: 'desktop',
|
||||
environment,
|
||||
rootURL: process.env.EMBER_CLI_ELECTRON ? '' : '/',
|
||||
locationType: process.env.EMBER_CLI_ELECTRON ? 'hash' : 'auto',
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "connect-client",
|
||||
"productName": "connect-client",
|
||||
"name": "desktop",
|
||||
"productName": "desktop",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"description": "Electron UI for client for Project Watchtower.",
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"name": "connect-client",
|
||||
"name": "desktop",
|
||||
"version": "0.0.0",
|
||||
"description": "Client UI for Project Watchtower.",
|
||||
"license": "MPL-2.0",
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -11,7 +11,7 @@
|
||||
{{content-for "test-head"}}
|
||||
|
||||
<link rel="stylesheet" href="{{rootURL}}assets/vendor.css">
|
||||
<link rel="stylesheet" href="{{rootURL}}assets/connect-client.css">
|
||||
<link rel="stylesheet" href="{{rootURL}}assets/desktop.css">
|
||||
<link rel="stylesheet" href="{{rootURL}}assets/test-support.css">
|
||||
|
||||
{{content-for "head-footer"}}
|
||||
@@ -24,7 +24,7 @@
|
||||
<script src="/testem.js" integrity=""></script>
|
||||
<script src="{{rootURL}}assets/vendor.js"></script>
|
||||
<script src="{{rootURL}}assets/test-support.js"></script>
|
||||
<script src="{{rootURL}}assets/connect-client.js"></script>
|
||||
<script src="{{rootURL}}assets/desktop.js"></script>
|
||||
<script src="{{rootURL}}assets/tests.js"></script>
|
||||
|
||||
{{content-for "body-footer"}}
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Reference in new issue
Block a user