Skip to content

Commit

Permalink
Merge pull request #71 from wayfair-incubator/releases/v0.0.3
Browse files Browse the repository at this point in the history
Releases/v0.0.3
  • Loading branch information
lelia authored Jan 11, 2022
2 parents 9310313 + 980d8d8 commit c737d0d
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 5 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,28 @@ All notable changes to `Forker` will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.0.3] - 2022-01-11

### Added

- Missing content from Wayfair's official [OSS Template](https://github.com/wayfair-incubator/oss-template)
- Dynamic release badging system for [README](https://github.com/wayfair-incubator/forker/blob/main/README.md)
- Linting configuration for all markdown files, including local and [CI](https://github.com/wayfair-incubator/forker/actions/workflows/lint.yml)
- Several major `npm` package upgrades suggested by Dependabot

### Changed

- Improved `README` content and clarified developer instructions
- Used named constants instead of numerical response codes
- Used OSPO service account for all workflow tests
- Updated vulnerable `npm` packages to compliant versions
- Updated Dependabot configuration to search for `github-actions` updates

### Fixed

- Token access issue with actions integration tests
- Numerous `npm` and `typescript` dependency conflicts

## [0.0.2] - 2021-10-22

### Changed
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ A newline-delimited (`"\n"`) string representing a list of allowed [license keys

### Typical

In most cases, you'll want to use the latest stable version (eg. `v0.0.2`):
In most cases, you'll want to use the latest stable version (eg. `v0.0.3`):

```yaml
uses: wayfair-incubator/forker@v0.0.2
uses: wayfair-incubator/forker@v0.0.3
with:
token: ${{ secrets.ACCESS_TOKEN }}
repo: tremor-runtime
Expand All @@ -99,7 +99,7 @@ with:
If you are automating forking on behalf of a GitHub organization, you may wish to leverage the optional `addUser` and `licenseAllowlist` params:

```yaml
uses: wayfair-incubator/forker@v0.0.2
uses: wayfair-incubator/forker@v0.0.3
with:
token: ${{ secrets.ACCESS_TOKEN }}
repo: tremor-runtime
Expand Down Expand Up @@ -147,7 +147,7 @@ Then run [ncc](https://github.com/zeit/ncc) and push the results:
npm run package
git add dist
git commit -a -m "prod dependencies"
git push origin releases/v0.0.2
git push origin releases/v0.0.3
```

> 💡 **Note:** We recommend using the `--license` option for `ncc`, which will create a license file for all of the production node modules used in your project.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "forker",
"version": "0.0.2",
"version": "0.0.3",
"private": true,
"description": "Github action for automating fork creation",
"main": "lib/main.js",
Expand Down

0 comments on commit c737d0d

Please sign in to comment.