Skip to content

Commit

Permalink
chore: manual dependabot - parse-url (#4379)
Browse files Browse the repository at this point in the history
  • Loading branch information
emilyjablonski authored Oct 9, 2024
1 parent 376745c commit f5f79e6
Show file tree
Hide file tree
Showing 7 changed files with 82 additions and 2,562 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,23 +75,28 @@ yarn dev
```

### Bloom's UI-Component Development

- Because Bloom's ui-components package is a separate open source repository, developing within both repos locally requires linking the folders with the following steps:

### Directory Setup
1. Clone both Bloom and the [ui-components repository](https://github.com/bloom-housing/ui-components) on the same directory level.

1. Clone both Bloom and the [ui-components repository](https://github.com/bloom-housing/ui-components) on the same directory level.

### Symlinking UI-C

1. In the Bloom directory, run `yarn link:uic`.
2. Open the next.config.js file in the public and partner's directory.
3. Uncomment the experimental property at the bottom of each file.
4. Follow the directions above to run Bloom locally.
These steps allow for two development patterns. You can edit ui-components within the node_modules of Bloom and the changes will be reflected in your local version of ui-components. Alternatively, you can edit the local version of ui-components and the changes will be reflected in the node_modules in Bloom. Both patterns will display up-to-date changes on the local server.
These steps allow for two development patterns. You can edit ui-components within the node_modules of Bloom and the changes will be reflected in your local version of ui-components. Alternatively, you can edit the local version of ui-components and the changes will be reflected in the node_modules in Bloom. Both patterns will display up-to-date changes on the local server.

### Unlinking UI-C

1. In the Bloom directory, run `yarn unlink:uic`.
2. Open the next.config.js file in the public and partner's directory.
3. Comment out the experimental property at the bottom of each file.
4. Follow the directions above to run Bloom locally.
Bloom will now be consuming the published version of @bloom-housing/ui-components specified in package.json and no local ui-component changes will be reflected.

Bloom will now be consuming the published version of @bloom-housing/ui-components specified in package.json and no local ui-component changes will be reflected.

## Contributing

Expand All @@ -101,13 +106,11 @@ Contributions to the core Bloom applications and services are welcomed. To help

Our development tasks are managed through GitHub issues and development in the vast majority of cases should be tied to an issue. Please feel free to submit issues even if you don't plan on implementing it yourself. Before creating an issue, check first to see if one already exists. When creating an issue, give it a descriptive title and include screenshots if relevant. Please don't start work on an issue without checking in with the Bloom team first as it may already be in development! You can tag us (@seanmalbert, @emilyjablonski, @yazeedloonat) to get started on an issue or ask any questions.

### Committing, Versioning, and Releasing

We are using [lerna](https://lerna.js.org/) as a monorepo management tool. It automatically versions, releases, and generates a changelog across our packages. In conjunction with lerna we are also using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), a specification for commit messages that helps lerna understand what level of change each commit is in order to automate our processes.
### Committing

On commit, two steps automatically run: (1) linting and (2) a verification of the conventional commit standard. We recommend not running `git commit` and instead globally installing commitizen (`npm install -g commitizen`) and then committing with `git cz` which will run a commit message CLI. The CLI asks a series of questions about your changeset and builds the commit message for you in the conventional commit format. You can also `git commit` with your own message if you are confident it follows the conventional standard.
We are also using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), a specification for commit messages that indicates what type and level of change each commit is.

In addition to commits needing to be formatted as conventional commits, if you are making different levels of version change across multiple packages, your commits must also be separated by package in order to avoid improperly versioning a package.
On commit, two steps automatically run: (1) linting and (2) a verification of the conventional commit standard. You can either, instead of running `git commit`, globally install commitizen (`npm install -g commitizen`) and then commit with `git cz` which will run a commit message CLI. The CLI asks a series of questions about your changeset and builds the commit message for you in the conventional commit format. You can alternatively run `git commit` with your own message if you are confident it follows the conventional standard, and it will fail if it does not.

On every merge to `main`, our Netlify and Heroku environment automatically deploys.

Expand Down
1 change: 0 additions & 1 deletion api/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store
Expand Down
18 changes: 0 additions & 18 deletions docs/BuildAndRelease.md

This file was deleted.

2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
"test:apps": "concurrently \"yarn dev:backend\" \"yarn test:app:public\"",
"test:apps:headless": "concurrently \"yarn dev:backend\" \"yarn test:app:public:headless\"",
"lint": "eslint '**/*.ts' '**/*.tsx' '**/*.js' && cd api && yarn lint",
"version:all": "lerna version --yes --no-commit-hooks --ignore-scripts --conventional-graduate --include-merged-tags --force-git-tag",
"test:backend:new": "cd api && yarn test --detectOpenHandles",
"test:backend:new:e2e": "cd api && yarn jest --config ./test/jest-e2e.config.js --detectOpenHandles",
"test:backend:new:cov": "cd api && yarn jest --config ./test/jest-with-coverage.config.js --detectOpenHandles --logHeapUsage",
Expand All @@ -71,7 +70,6 @@
"eslint-plugin-react-hooks": "^4.6.0",
"husky": "^4.3.0",
"jest": "^26.5.3",
"lerna": "^4.0.0",
"lint-staged": "^10.4.0",
"prettier": "^2.8.8",
"react": "18.2.0",
Expand Down
1 change: 1 addition & 0 deletions sites/partners/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"ag-grid-react": "^26.0.0",
"axios": "^0.28.0",
"axios-cookiejar-support": "4.0.6",
"clone-deep": "^4.0.1",
"dayjs": "^1.10.7",
"dotenv": "^8.2.0",
"http-cookie-agent": "5.0.2",
Expand Down
1 change: 1 addition & 0 deletions sites/public/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"autoprefixer": "^10.3.4",
"axios": "^0.28.0",
"axios-cookiejar-support": "4.0.6",
"clone-deep": "^4.0.1",
"dayjs": "^1.10.7",
"deasync": "0.1.28",
"dotenv": "^8.2.0",
Expand Down
Loading

0 comments on commit f5f79e6

Please sign in to comment.