Skip to content

Commit

Permalink
Copy paste rynovate @ seek-oss/rynovate@598ee7d
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronMoat committed Apr 8, 2024
1 parent eb02ac2 commit 8c56510
Show file tree
Hide file tree
Showing 15 changed files with 6,804 additions and 180 deletions.
10 changes: 0 additions & 10 deletions .editorconfig

This file was deleted.

1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @seek-oss/indirect
31 changes: 31 additions & 0 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Validate

on:
- pull_request
- push

permissions: {}

jobs:
validate:
name: Lint & Test
permissions:
checks: write
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@v3

- name: Set up Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: 18.x

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Test
run: yarn test

- name: Lint
run: yarn lint
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
node_modules
*.log
package-lock.json
yarn.lock
node_modules/
3 changes: 0 additions & 3 deletions .pullapprove.yml

This file was deleted.

12 changes: 0 additions & 12 deletions .travis.yml

This file was deleted.

114 changes: 114 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# Contributing

Hi there, thanks for checking out our repo!

Rynovate is a set of [shareable Renovate config presets] that we use at SEEK.
While third-party contributions are certainly welcome,
this project is entirely driven by our internal requirements.

SEEKers: this repo is public,
so don't commit or post anything that isn't ready for the entire world to see.

## Table of contents

- [Getting started](#getting-started)
- [I want to discuss or report something](#i-want-to-discuss-or-report-something)
- [I want to contribute a change](#i-want-to-contribute-a-change)
- [Development](#development)
- [Git workflow](#git-workflow)
- [Testing](#testing)
- [Releases](#releases)

## Getting started

Rynovate is documented through its [README](/README.md).
Its presets are mastered as JSON files in the repository root.

Keep in mind that Renovate is incredibly difficult to configure correctly.
Certain "bugs" in our presets are likely unfixable based on Renovate's current configuration logic.

### I want to discuss or report something

[Submit an issue] if you have a question, feature request or bug report.

If you work at SEEK, [#typescriptification] is your friend.

### I want to contribute a change

Follow the [development](#development) steps below to [create a pull request].
Please explain the context and intent of your change so we can better validate it.

## Development

### Git workflow

We use [GitHub flow](https://guides.github.com/introduction/flow/).

Create a new branch off of the latest commit on master:

```shell
git fetch origin
git switch --create your-branch-name origin/master
```

Develop, [test](#testing) and commit your changes on this branch.

```shell
git add --all
git commit
```

Finally, push your branch to GitHub and [create a pull request]:

```shell
git push --set-upstream origin your-branch-name
```

If you don't have push access,
you may need to [fork the repo] and push there instead:

```shell
git remote add fork git@github.com:your-username/rynovate.git
git push --set-upstream fork your-branch-name
```

A maintainer will get to your pull request and review the changes.
If all is well, they will merge your pull request into master.

### Testing

If you are making a non-trivial change,
we recommend that you test it out on an individual repository first.

Extending an existing Rynovate config is often not enough,
as package rule ordering can affect Renovate's behaviour in non-obvious ways.

```json5
// Not recommended for testing changes to the preset. Instead, copy across the
// raw JSON of the preset and tweak it from there.
{
extends: ['github>seek-oss/rynovate'],
packageRules: [
// ...
],
}
```

Another option for testing is to freshly [install Renovate] on a repository.

The Renovate bot will create a `Configure Renovate` [onboarding PR],
which includes a preview of the pull requests it will open based on the provided config.
You can push changes to this onboarding PR to update the preview.

## Releases

Rynovate consumers track the master branch on GitHub,
so merging a pull request constitutes a release.

[#typescriptification]: https://seekchat.slack.com/channels/typescriptification
[create a pull request]: https://github.com/seek-oss/rynovate/compare
[fork the repo]: https://github.com/seek-oss/rynovate/fork
[install renovate]: https://github.com/apps/renovate/installations/new
[onboarding pr]: https://docs.renovatebot.com/configure-renovate/
[shareable renovate config presets]: https://docs.renovatebot.com/config-presets/
[submit an issue]: https://github.com/seek-oss/rynovate/issues/new/choose
25 changes: 12 additions & 13 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
MIT License

Copyright (c) 2018 SEEK
Copyright (c) 2019 SEEK

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Loading

0 comments on commit 8c56510

Please sign in to comment.