arbetsformedlingen/mina-sidor-fa-web
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Erik Tiekstra
2021-09-06 10:55:27 +02:00
parent 9253edfe62
commit db03d97d54
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -32,6 +32,10 @@ Run `npm run new-component my-component --project=my-app` to generate a new comp
Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
#### Mock-api
If you want to use the mock-api, read the README [here](./mock-api/mina-sidor-fa).
#### Dotnet API
Run `npm run build:api` to build the project using the Dotnet API.
@@ -72,26 +76,26 @@ Run `npm run nx dep-graph` to see a diagram of the dependencies of your projects
- **startpage:** Added headings and description to the startpage ([TV-1234](https://jira.arbetsformedlingen.se/browse/TV-1234)) ([commit-hash](https://bitbucket.arbetsformedlingen.se/projects/tea/repos/mina-sidor-fa-web/commits/commit-hash))
```
- Upon merge, Open Shift will deploy the application to [AUTO](http://mina-sidor-fa-auto.tocp.arbetsformedlingen.se) and [TEST](http://mina-sidor-fa-test.tocp.arbetsformedlingen.se).
- Upon merge, Open Shift will deploy the application to [AUTO](http://mina-sidor-fa-auto.tocp.arbetsformedlingen.se) and [SYS](http://mina-sidor-fa-sys.tocp.arbetsformedlingen.se).
## Release and deploy
We use a semi-automated release and deploy to different test-enviroments. A release script is used in combination with [semantic-release](https://semantic-release.gitbook.io/semantic-release/) to add the correct version of the application and changes to the changelog. The deployments are made depending on which branches are updated:
- `develop` is automatically deployed to [AUTO](http://mina-sidor-fa-auto.tocp.arbetsformedlingen.se) and [TEST](http://mina-sidor-fa-test.tocp.arbetsformedlingen.se).
- `next` is automatically deployed to [SYS](http://mina-sidor-fa-sys.tocp.arbetsformedlingen.se).
- `develop` is automatically deployed to [AUTO](http://mina-sidor-fa-auto.tocp.arbetsformedlingen.se) and [SYS](http://mina-sidor-fa-sys.tocp.arbetsformedlingen.se).
- `next` is automatically deployed to [TEST](http://mina-sidor-fa-test.tocp.arbetsformedlingen.se).
- `main` is automatically deployed to [ACC](http://mina-sidor-fa-acc.tocp.arbetsformedlingen.se). After this is completed, a question needs to be answered whether the image should be deployed to PROD.
### Deploy to SYS
### Deploy to TEST
To deploy the application to SYS you need to create a release. Make sure you are in the `develop` branch and are up-to-date with origin. Then run `npm run release`. This will:
To deploy the application to TEST you need to create a release. Make sure you are in the `develop` branch and are up-to-date with origin. Then run `npm run release`. This will:
- Update the [CHANGELOG.md](CHANGELOG.md) and copies the CHANGELOG to assets.
- Bump the applications version according to semantic versioning.
- Commits the CHANGELOG to `develop` and pushes it to origin.
- Merge `develop` into `next` and pushes `next` to origin.
Open Shift will deploy the application to [SYS](http://mina-sidor-fa-sys.tocp.arbetsformedlingen.se).
Open Shift will deploy the application to [TEST](http://mina-sidor-fa-test.tocp.arbetsformedlingen.se).
### Release to ACC and PROD