dwardu89 / aws-ssm-parameter-store

A GitHub Action to store parameters into AWS Systems Manager Parameter Store.
Apache License 2.0
10 stars 10 forks source link

docs(README): Update action reference #22

Closed dwardu89 closed 1 year ago

dwardu89 commented 1 year ago

Fix Issues to address Issue #21

pull-request-quantifier-deprecated[bot] commented 1 year ago

This PR has 177554 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

``` Label : Extra Large Size : +177550 -4 Percentile : 100% Total files changed: 2952 Change summary by file extension: .yml : +18 -2 .md : +20156 -2 .json : +75414 -0 .ts : +27086 -0 .js : +44025 -0 .map : +0 -0 .txt : +532 -0 .html : +10 -0 .eslintignore : +1 -0 .eslintrc : +4 -0 .nycrc : +7 -0 node_modules/.bin/ncc : +1 -0 node_modules/.bin/uuid : +1 -0 node_modules/.bin/xml2js : +1 -0 node_modules/@actions/http-client/LICENSE : +15 -0 node_modules/@aws-crypto/ie11-detection/LICENSE : +169 -0 node_modules/@aws-crypto/sha256-browser/LICENSE : +169 -0 node_modules/@aws-crypto/sha256-js/LICENSE : +169 -0 node_modules/@aws-crypto/supports-web-crypto/LICENSE : +169 -0 node_modules/@aws-crypto/util/LICENSE : +169 -0 node_modules/@aws-sdk/abort-controller/LICENSE : +169 -0 node_modules/@aws-sdk/client-ssm/LICENSE : +169 -0 node_modules/@aws-sdk/client-sso/LICENSE : +169 -0 node_modules/@aws-sdk/client-sts/LICENSE : +169 -0 node_modules/@aws-sdk/config-resolver/LICENSE : +169 -0 node_modules/@aws-sdk/credential-provider-env/LICENSE : +169 -0 node_modules/@aws-sdk/credential-provider-imds/LICENSE : +169 -0 node_modules/@aws-sdk/credential-provider-ini/LICENSE : +169 -0 node_modules/@aws-sdk/credential-provider-node/LICENSE : +169 -0 node_modules/@aws-sdk/credential-provider-process/LICENSE : +169 -0 node_modules/@aws-sdk/credential-provider-sso/LICENSE : +169 -0 node_modules/@aws-sdk/credential-provider-web-identity/LICENSE : +169 -0 node_modules/@aws-sdk/fetch-http-handler/LICENSE : +169 -0 node_modules/@aws-sdk/hash-node/LICENSE : +169 -0 node_modules/@aws-sdk/invalid-dependency/LICENSE : +169 -0 node_modules/@aws-sdk/is-array-buffer/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-content-length/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-host-header/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-logger/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-recursion-detection/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-retry/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-sdk-sts/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-serde/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-signing/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-stack/LICENSE : +169 -0 node_modules/@aws-sdk/middleware-user-agent/LICENSE : +169 -0 node_modules/@aws-sdk/node-config-provider/LICENSE : +169 -0 node_modules/@aws-sdk/node-http-handler/LICENSE : +169 -0 node_modules/@aws-sdk/property-provider/LICENSE : +169 -0 node_modules/@aws-sdk/protocol-http/LICENSE : +169 -0 node_modules/@aws-sdk/querystring-builder/LICENSE : +169 -0 node_modules/@aws-sdk/querystring-parser/LICENSE : +169 -0 node_modules/@aws-sdk/service-error-classification/LICENSE : +169 -0 node_modules/@aws-sdk/shared-ini-file-loader/LICENSE : +169 -0 node_modules/@aws-sdk/signature-v4/LICENSE : +169 -0 node_modules/@aws-sdk/smithy-client/LICENSE : +169 -0 node_modules/@aws-sdk/types/LICENSE : +169 -0 node_modules/@aws-sdk/url-parser/LICENSE : +169 -0 node_modules/@aws-sdk/util-base64-browser/LICENSE : +169 -0 node_modules/@aws-sdk/util-base64-node/LICENSE : +169 -0 node_modules/@aws-sdk/util-body-length-browser/LICENSE : +169 -0 node_modules/@aws-sdk/util-body-length-node/LICENSE : +169 -0 node_modules/@aws-sdk/util-buffer-from/LICENSE : +169 -0 node_modules/@aws-sdk/util-config-provider/LICENSE : +169 -0 node_modules/@aws-sdk/util-defaults-mode-browser/LICENSE : +169 -0 node_modules/@aws-sdk/util-defaults-mode-node/LICENSE : +169 -0 node_modules/@aws-sdk/util-hex-encoding/LICENSE : +169 -0 node_modules/@aws-sdk/util-locate-window/LICENSE : +169 -0 node_modules/@aws-sdk/util-middleware/LICENSE : +169 -0 node_modules/@aws-sdk/util-uri-escape/LICENSE : +169 -0 node_modules/@aws-sdk/util-user-agent-browser/LICENSE : +169 -0 node_modules/@aws-sdk/util-user-agent-node/LICENSE : +169 -0 node_modules/@aws-sdk/util-utf8-browser/LICENSE : +169 -0 node_modules/@aws-sdk/util-utf8-node/LICENSE : +169 -0 node_modules/@aws-sdk/util-waiter/LICENSE : +169 -0 node_modules/@octokit/auth-token/LICENSE : +17 -0 node_modules/@octokit/core/LICENSE : +17 -0 node_modules/@octokit/endpoint/LICENSE : +17 -0 node_modules/@octokit/graphql/LICENSE : +17 -0 node_modules/@octokit/openapi-types/LICENSE : +4 -0 node_modules/@octokit/plugin-paginate-rest/LICENSE : +4 -0 node_modules/@octokit/plugin-rest-endpoint-methods/LICENSE : +4 -0 node_modules/@octokit/request-error/LICENSE : +17 -0 node_modules/@octokit/request/LICENSE : +17 -0 node_modules/@octokit/types/LICENSE : +4 -0 node_modules/@vercel/ncc/LICENSE : +4 -0 node_modules/available-typed-arrays/LICENSE : +17 -0 ``` > Change counts above are quantified counts, based on the [PullRequestQuantifier customizations](https://github.com/microsoft/PullRequestQuantifier/blob/main/docs/prquantifier-yaml.md).

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a balance between between PR complexity and PR review overhead. PRs within the optimal size (typical small, or medium sized PRs) mean: - Fast and predictable releases to production: - Optimal size changes are more likely to be reviewed faster with fewer iterations. - Similarity in low PR complexity drives similar review times. - Review quality is likely higher as complexity is lower: - Bugs are more likely to be detected. - Code inconsistencies are more likely to be detected. - Knowledge sharing is improved within the participants: - Small portions can be assimilated better. - Better engineering practices are exercised: - Solving big problems by dividing them in well contained, smaller problems. - Exercising separation of concerns within the code changes. #### What can I do to optimize my changes - Use the PullRequestQuantifier to quantify your PR accurately - Create a context profile for your repo using the [context generator](https://github.com/microsoft/PullRequestQuantifier/releases) - Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the `Excluded` section from your `prquantifier.yaml` context profile. - Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your `prquantifier.yaml` context profile. - Only use the labels that matter to you, [see context specification](./docs/prquantifier-yaml.md) to customize your `prquantifier.yaml` context profile. - Change your engineering behaviors - For PRs that fall outside of the desired spectrum, review the details and check if: - Your PR could be split in smaller, self-contained PRs instead - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR). #### How to interpret the change counts in git diff output - One line was added: `+1 -0` - One line was deleted: `+0 -1` - One line was modified: `+1 -1` (git diff doesn't know about modified, it will interpret that line like one addition plus one deletion) - Change percentiles: Change characteristics (addition, deletion, modification) of this PR in relation to all other PRs within the repository.


Was this comment helpful? :thumbsup:  :ok_hand:  :thumbsdown: (Email) Customize PullRequestQuantifier for this repository.