@cfpb/ccdb5-ui 2.5.0 → 2.5.1

package/README.md

@@ -4,9 +4,10 @@
 This application allows consumers to search complaints submitted to the CFPB by other consumers.
 
 #### Technology Stack
+
 This application is written in JavaScript and [Less](http://lesscss.org) within
 the [React](https://facebook.github.io/react/) + [Redux](http://redux.js.org/)
-framework.  It uses [Webpack](http://webpack.github.io/docs/) at runtime to
+framework. It uses [Webpack](http://webpack.github.io/docs/) at runtime to
 manage module loading.
 
 The code is written with the [ES6](http://es6-features.org/) feature set
@@ -20,6 +21,7 @@ Unit testing of the application is performed within
 [yarn](https://yarnpkg.com/) is used to manage the build/test/deploy cycle.
 
 #### Screenshot
+
 ![screen August 17, 2017](documentation/screenshot.png)
 
 ## Dependencies
@@ -48,19 +50,20 @@ Please see the subsection Configuring in [INSTALL](INSTALL.md#configuring)
 #### Developing code
 
 ###### Prerequisites
+
 This application depends on the [Public Complaints API](https://github.com/cfpb/ccdb5-api)
 to be available.
 
 For local development, you will need to the following:
 
-* [Run consumerfinance.gov locally (which includes the API)](https://github.com/cfpb/consumerfinance.gov#quickstart).
-* [Fill the local Elasticsearch with data](https://github.com/cfpb/ccdb-data-pipeline/blob/main/INSTALL.md).
+- [Run consumerfinance.gov locally (which includes the API)](https://github.com/cfpb/consumerfinance.gov#quickstart).
+- [Fill the local Elasticsearch with data](https://github.com/cfpb/ccdb-data-pipeline/blob/main/INSTALL.md).
 
-***Note:*** The Public Complaints API runs as part of consumerfinance.gov, but you can run the API as an independent app: 
+**_Note:_** The Public Complaints API runs as part of consumerfinance.gov, but you can run the API as an independent app:
 
-* Ensure the consumerfinance.gov python container is stopped with `docker-compose stop python`.
-* [Install the API](https://github.com/cfpb/ccdb5-api#setup--running) and run it with `python manage.py runserver`.
-* Edit [`env.js`](https://github.com/cfpb/ccdb5-ui/blob/main/config/env.js#L104) to point  `ccdbApiUrl.dev` to the locally running API (likely at `http://localhost:8000/`).
+- Ensure the consumerfinance.gov python container is stopped with `docker-compose stop python`.
+- [Install the API](https://github.com/cfpb/ccdb5-api#setup--running) and run it with `python manage.py runserver`.
+- Edit [`env.js`](https://github.com/cfpb/ccdb5-ui/blob/main/config/env.js#L104) to point `ccdbApiUrl.dev` to the locally running API (likely at `http://localhost:8000/`).
 
 ###### Code-Build cycle
 
@@ -80,6 +83,7 @@ Enter `Control-C` to exit development mode
 ## How to test the software
 
 #### Unit testing
+
 To launch the JavaScript test runner in interactive watch/test mode:
 
 ```bash
@@ -100,9 +104,11 @@ Timeouts and the local `baseUrl` are set in cypress.json
 ### To run Cypress tests locally
 
 - Set your node env to development:
+
 ```bash
 export NODE_ENV=development
 ```
+
 You can run the tests in headless mode and just see results, or you can open the Cypress test-runner, which lets you choose tests and watch them run in a Chrome browser. Having the live browser allows you to see page state during tests, and you can open Chrome dev tools to check console errors and network requests.
 
 To run local tests and just see results:
@@ -124,6 +130,7 @@ yarn run cypress open --browser chrome
 ```
 
 ### To run against a server
+
 You can also run Cypress tests against a server by passing a `baseUrl` config with the path to the server's consumer complaints search page.
 
 **Note**: If you run against a server that has Django's `DEBUG=False` setting,
@@ -134,6 +141,70 @@ Our internal DEV servers can be deployed with `DEBUG=True` for running Cypress t
 yarn run cypress run --browser chrome --headless --config baseUrl=https://[DEV SERVER URL]/data-research/consumer-complaints/search/
 ```
 
+## Release management
+
+Ready to publish changes to npm?
+
+### Config prep:
+
+1. If you don't have a `.env` file,
+   copy it from the sample file with `cp .env_SAMPLE .env`.
+2. Add a `GITHUB_TOKEN` in your `.env` file (see
+   https://github.com/settings/tokens/new?scopes=repo&description=ccdb-release-it
+   to create the token value).
+   Set the desired token expiry length and click generate.
+3. You need to be part of the collaborators for
+   https://www.npmjs.com/package/@cfpb/ccdb5-ui.
+   Ask a member of the [consumerfinance.gov](https://github.com/cfpb/consumerfinance.gov) team if you are not.
+
+### Steps:
+
+1. Ensure you're on `main` and `git pull` to confirm you're up-to-date.
+2. Run `yarn run build` to ensure you have the latest built artifacts for npm.
+   Commit any changes to `/dist/` directory files to `main`.
+3. Source your `.env` with `source ./.env` (if `GITHUB_TOKEN` in unset).
+4. Log into npm with `npm login` (if not already logged in).
+5. Run `yarn run release` to start the release.
+   This'll run the build scripts to copy the latest JS into
+   the `dist` directory. It then uses
+   [release-it](https://github.com/release-it/release-it/) to publish to
+   npm and create a GitHub tag.
+6. Manually create an entry in the GitHub releases changelog by visiting
+   https://github.com/cfpb/ccdb5-ui/releases and clicking "Draft a new release":
+   - Choose the latest tag generated by the release script in the prior step.
+   - Title the release the same as the release version.
+   - Click "Auto-generate release notes" or manually enter release notes.
+   - Click "Publish release"
+
+### Post-publish steps in consumerfinance.gov
+
+1. Navigate to the root directory of the
+   [consumerfinance.gov](https://github.com/cfpb/consumerfinance.gov) repo.
+2. Create a new branch.
+3. Move to CCDB asset app directory with `cd cfgov/unprocessed/apps/ccdb-search/`.
+4. `npx yarn-check -u` and update to the latest ccdb5-ui version.
+5. Commit the changes to the npm package and node cache.
+6. Open a Pull Request from the branch for review.
+
+### Troubleshooting
+
+- Ensure your npm version is up-to-date.
+- `yarn run release` can't find https://www.npmjs.com/package/@cfpb/ccdb5-ui
+  and doesn't succeed.
+  - You're probably not an npm maintainer on the ccdb5-ui project.
+    Reach out to a core consumerfinance.gov member to get access.
+- When updating the package in the consumerfinance.gov repo you get a message
+  similar to "Cannot download package in offline mode."
+  - This is likely an outdated cache issue, perform the following:
+    - Delete `cfgov/unprocessed/apps/ccdb-search/npm-packages-offline-cache`
+    - Delete `cfgov/unprocessed/apps/ccdb-search/node_modules`
+    - Delete `cfgov/unprocessed/apps/ccdb-search/yarn.lock`
+    - Temporarily edit the root directory `.yarnrc` file
+      and remove the last two lines and save.
+    - Run `yarn cache clean; yarn install`
+      from `cfgov/unprocessed/apps/ccdb-search/`.
+    - Re-add the last two lines to the root `.yarnrc` file.
+
 ## Getting help
 
 If you have questions, concerns, bug reports, etc, please file an issue in this
@@ -143,23 +214,24 @@ repository's [Issue Tracker](https://github.com/cfpb/ccdb5-ui/issues).
 
 [CONTRIBUTING](CONTRIBUTING.md).
 
-----
+---
 
 ## Open source licensing info
+
 1. [TERMS](TERMS.md)
 2. [LICENSE](LICENSE)
 3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
 
-
-----
+---
 
 ## Links that were helpful
 
 #### React-Redux
-* https://egghead.io/lessons/javascript-redux-the-single-immutable-state-tree
-* https://medium.com/lexical-labs-engineering/redux-best-practices-64d59775802e
-* https://medium.com/@kylpo/redux-best-practices-eef55a20cc72
-* https://github.com/markerikson/react-redux-links/blob/main/tips-and-best-practices.md
-* https://getstream.io/blog/react-redux-best-practices-gotchas/
-* https://tech.affirm.com/redux-patterns-and-anti-patterns-7d80ef3d53bc
-* https://github.com/gaearon/redux-devtools
+
+- https://egghead.io/lessons/javascript-redux-the-single-immutable-state-tree
+- https://medium.com/lexical-labs-engineering/redux-best-practices-64d59775802e
+- https://medium.com/@kylpo/redux-best-practices-eef55a20cc72
+- https://github.com/markerikson/react-redux-links/blob/main/tips-and-best-practices.md
+- https://getstream.io/blog/react-redux-best-practices-gotchas/
+- https://tech.affirm.com/redux-patterns-and-anti-patterns-7d80ef3d53bc
+- https://github.com/gaearon/redux-devtools