Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Commit

Permalink
docs: update Changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
rsmayda committed Sep 14, 2020
1 parent f8fde57 commit a476dff
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 33 deletions.
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,22 @@
# Changelog

All notable changes to this project will be documented in this file.

## [1.1.0] - 2020-09-11

### Added

- Add budget integration - Admin users can set up budget and alert notifications for AWS member accounts on-boarded with Service Workbench
- Adding RStudio Service Catalog product - Users can now use RStudio in Service Catalog

## [1.0.1] - 2020-08-31

### Added

- Bug fix for Service Catalog product artifact creation (occurs when CfN template is edited in-place)

## [1.0.0] - 2020-08-28

### Added
- Initial launch! :rocket:

- Initial launch! :rocket:
1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.
20 changes: 9 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,23 @@ documentation, we greatly value feedback and contributions from our community.
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
information to effectively respond to your bug report or contribution.


## Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

* A reproducible test case or series of steps
* The version of our code being used
* Any modifications you've made relevant to the bug
* Anything unusual about your environment or deployment

- A reproducible test case or series of steps
- The version of our code being used
- Any modifications you've made relevant to the bug
- Anything unusual about your environment or deployment

## Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the *master* branch.
1. You are working against the latest source on the _master_ branch.
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

Expand All @@ -39,20 +38,19 @@ To send us a pull request, please:
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).


## Finding contributions to work on
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
opensource-codeofconduct@amazon.com with any additional questions or comments.


## Security issue notifications
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.

## Licensing

Expand Down
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Node.js v12.x or later is required.
Before you can build this project, you need to install [pnpm](https://pnpm.js.org/en/). Run the following command:

```bash
$ npm install -g pnpm
npm install -g pnpm
```

To create the initial settings files, take a look at the example.yml settings file in main/config/settings/example.yml and create your own copy.
Expand All @@ -40,7 +40,7 @@ In the rest of this README, \$STAGE is used to designate the stage.
Now, let's perform an initial deployment. Note that when invoked without parameters, this will assume a deployment stage of \$USER, which is the logged-in user name on Mac and Linux systems.

```bash
$ scripts/environment-deploy.sh
scripts/environment-deploy.sh
```

You can override the default stage name of \$USER if you prefer. For example, if you want your stage name to be `qa`, then:
Expand All @@ -51,27 +51,27 @@ You can override the default stage name of \$USER if you prefer. For example, if
Following an initial successful deployment, you can subsequently deploy updates to the infrastructure, backend, and post-deployment components as follows:

```bash
$ cd main/solution/<component>
$ pnpx sls deploy -s $STAGE
$ cd -
cd main/solution/<component>
pnpx sls deploy -s $STAGE
cd -
```

To run (rerun) the post-deployment steps:

```bash
$ cd main/solution/post-deployment
$ pnpx sls invoke -f postDeployment -s $STAGE
$ cd -
cd main/solution/post-deployment
pnpx sls invoke -f postDeployment -s $STAGE
cd -
```

To re-deploy the UI

```bash
$ cd main/solution/ui
$ pnpx sls package-ui --stage $STAGE --local=true
$ pnpx sls package-ui --stage $STAGE
$ pnpx sls deploy-ui --stage $STAGE --invalidate-cache=true
$ cd -
cd main/solution/ui
pnpx sls package-ui --stage $STAGE --local=true
pnpx sls package-ui --stage $STAGE
pnpx sls deploy-ui --stage $STAGE --invalidate-cache=true
cd -
```

To view information about the deployed components (e.g. CloudFront URL, root password), run the
Expand All @@ -85,17 +85,17 @@ Once you have deployed the app and the UI, you can start developing locally on y
You will be running a local server that uses the same lambda functions code. To start local development, run the following commands to run a local server:

```bash
$ cd main/solution/backend
$ pnpx sls offline -s $STAGE
$ cd -
cd main/solution/backend
pnpx sls offline -s $STAGE
cd -
```

Then, in a separate terminal, run the following commands to start the ui server and open up a browser:

```bash
$ cd main/solution/ui
$ pnpx sls start-ui -s $STAGE
$ cd -
cd main/solution/ui
pnpx sls start-ui -s $STAGE
cd -
```

---
Expand Down Expand Up @@ -165,8 +165,8 @@ They are meant to provide a sample service, a sample controller and a sample UI
To audit the installed NPM packages, run the following commands:

```bash
$ cd <root of git repo>
$ pnpm audit
cd <root of git repo>
pnpm audit
```

Please follow prevailing best practices for auditing your NPM dependencies and fixing them as needed.
Expand Down

0 comments on commit a476dff

Please sign in to comment.