Skip to content

Commit

Permalink
Migrate repo (#26)
Browse files Browse the repository at this point in the history
* Migrate repo
* Account for dependency typing issue and minimise risk of happening again
  • Loading branch information
jonnydgreen authored Dec 2, 2023
1 parent b7ced5d commit 115f463
Show file tree
Hide file tree
Showing 11 changed files with 204 additions and 53 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ jobs:
runs-on: ubuntu-latest
needs: [test, lint, build]
if: |
github.repository == 'jonnydgreen/nifty-lil-tricks-testing' &&
github.repository == 'nifty-lil-tricks/testing' &&
github.ref == 'refs/heads/main'
steps:
- name: Clone repository
Expand All @@ -138,8 +138,8 @@ jobs:
uses: actions/create-github-app-token@v1
id: app-token
with:
app-id: ${{ secrets.JONNYDGREEN_BOT_APP_ID }}
private-key: ${{ secrets.JONNYDGREEN_BOT_PRIVATE_KEY }}
app-id: ${{ secrets.NIFTY_LIL_TRICKS_BOT_APP_ID }}
private-key: ${{ secrets.NIFTY_LIL_TRICKS_BOT_PRIVATE_KEY }}

- name: Release if version change
shell: bash
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/version_bump.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ jobs:

- name: Run version bump
run: |
git remote add upstream https://github.com/jonnydgreen/nifty-lil-tricks-testing
git remote add upstream https://github.com/nifty-lil-tricks/testing
./_tools/release_bump_version.ts --${{github.event.inputs.releaseKind}}
- uses: actions/create-github-app-token@v1
id: app-token
with:
app-id: ${{ secrets.JONNYDGREEN_BOT_APP_ID }}
private-key: ${{ secrets.JONNYDGREEN_BOT_PRIVATE_KEY }}
app-id: ${{ secrets.NIFTY_LIL_TRICKS_BOT_APP_ID }}
private-key: ${{ secrets.NIFTY_LIL_TRICKS_BOT_PRIVATE_KEY }}

- name: Create PR
env:
Expand Down
129 changes: 129 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behaviour that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behaviour include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behaviour and will take appropriate and fair corrective action in
response to any behaviour that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be
reported to the community leaders responsible for enforcement at
hello[@]jonnydgreen.com. All complaints will be reviewed and investigated
promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behaviour deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behaviour was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behaviour. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behaviour.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behaviour, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
26 changes: 22 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ git config core.hooksPath .githooks

## Install Deno

> **Note:** This project uses Deno version >= 1.38.x
### Via asdf

[Guide](https://asdf-vm.com/guide/getting-started.html)
Expand All @@ -26,8 +28,15 @@ asdf install

[Guide](https://deno.land/manual/getting_started/installation)

## Install Docker

[Install Docker](https://docs.docker.com/get-docker/)

## Testing

> **Note:** Before running the tests, ensure the above pre-requisites are are
> satisfied and Docker is up and running.
To run tests, run the following:

```sh
Expand All @@ -48,22 +57,31 @@ To check report, run the following:
deno task report
```

## Cache

Deno uses a cache as defined here. Sometimes, this can get out of sync with the
latest available dependencies. To reload the cache, run the following:

```sh
deno task reload
```

## Release Process

To release a new version, take the following steps:

- Bump the version by running the
[`version_bump`](https://github.com/jonnydgreen/nifty-lil-tricks-testing/actions/workflows/version_bump.yml)
[`version_bump`](https://github.com/nifty-lil-tricks/testing/actions/workflows/version_bump.yml)
GitHub Action and choose the appropriate version bump:

![version-bump](docs/img/version-bump.png)

- Wait for the Pull Request to be created and merge this into main.

- Wait for the
[`main` branch action](https://github.com/jonnydgreen/nifty-lil-tricks-testing/actions?query=branch%3Amain)
[`main` branch action](https://github.com/nifty-lil-tricks/testing/actions?query=branch%3Amain)
to complete.

- Find the created
[draft release](https://github.com/jonnydgreen/nifty-lil-tricks-testing/releases)
and publish it.
[draft release](https://github.com/nifty-lil-tricks/testing/releases) and
publish it.
32 changes: 17 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
![Nifty li'l tricks Logo](https://raw.githubusercontent.com/nifty-lil-tricks/assets/main/nifty-lil-tricks-logo.png)

# nifty_lil_tricks_testing

**Note: this package and selected plugins are currently a work in progress**

[![Latest Version](https://img.shields.io/npm/v/@nifty-lil-tricks/testing?style=flat-square)](https://www.npmjs.com/package/@nifty-lil-tricks/testing)
[![GitHub License](https://img.shields.io/github/license/jonnydgreen/nifty-lil-tricks-testing?style=flat-square)](https://raw.githubusercontent.com/jonnydgreen/nifty-lil-tricks-testing/main/LICENSE)
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/jonnydgreen/nifty-lil-tricks-testing)
[![codecov](https://codecov.io/gh/jonnydgreen/nifty-lil-tricks-testing/branch/main/graph/badge.svg)](https://codecov.io/gh/jonnydgreen/nifty-lil-tricks-testing)
[![GitHub License](https://img.shields.io/github/license/nifty-lil-tricks/testing?style=flat-square)](https://raw.githubusercontent.com/nifty-lil-tricks/testing/main/LICENSE)
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/nifty-lil-tricks/testing)
[![codecov](https://codecov.io/gh/nifty-lil-tricks/testing/branch/main/graph/badge.svg)](https://codecov.io/gh/nifty-lil-tricks/testing)

A selection of useful utilities (or nifty li'l tricks!) for all things testing.

Expand Down Expand Up @@ -55,11 +57,11 @@ The following features are supported
The following plugins are available to that make use of the setup tests plugin
system.

| Plugin | Description | Status | Npm | Docs |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| [PostgreSQl](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/plugin_postgresql/README.md) | Setup the World's Most Advanced Open Source Relational Database for testing. It has the following features: <br><ul><li>Setup a Postgresql server in [Docker](https://www.docker.com/) for testing.</li><li>Setup an existing Postgresql server for testing.</li><li>Run migrations on the configured Postgresql server.</li><li>Seed the configured Postgresql server with data.</li></ul> || [![Latest Version](https://img.shields.io/npm/v/@nifty-lil-tricks/testing-plugin-postgresql?style=flat-square)](https://www.npmjs.com/package/@nifty-lil-tricks/testing-plugin-postgresql) | [Docs](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/plugin_postgresql/README.md). |
| [NestJS Server](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/plugin_nestjs/README.md) | Setup a progressive Node.js framework for building efficient, reliable and scalable server-side applications for testing. || [![Latest Version](https://img.shields.io/npm/v/@nifty-lil-tricks/testing-plugin-nestjs?style=flat-square)](https://www.npmjs.com/package/@nifty-lil-tricks/testing-plugin-nestjs) | [Docs](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/plugin_nestjs/README.md) |
| [Express Server](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/plugin_express/README.md) | Setup a minimal and flexible Node.js web Express application for testing. | 🚧 | [![Latest Version](https://img.shields.io/npm/v/@nifty-lil-tricks/testing-plugin-express?style=flat-square)](https://www.npmjs.com/package/@nifty-lil-tricks/testing-plugin-express) | [Docs](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/plugin_express/README.md) |
| Plugin | Description | Status | Npm | Docs |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| [PostgreSQl](https://github.com/nifty-lil-tricks/testing/blob/main/plugin_postgresql/README.md) | Setup the World's Most Advanced Open Source Relational Database for testing. It has the following features: <br><ul><li>Setup a Postgresql server in [Docker](https://www.docker.com/) for testing.</li><li>Setup an existing Postgresql server for testing.</li><li>Run migrations on the configured Postgresql server.</li><li>Seed the configured Postgresql server with data.</li></ul> || [![Latest Version](https://img.shields.io/npm/v/@nifty-lil-tricks/testing-plugin-postgresql?style=flat-square)](https://www.npmjs.com/package/@nifty-lil-tricks/testing-plugin-postgresql) | [Docs](https://github.com/nifty-lil-tricks/testing/blob/main/plugin_postgresql/README.md). |
| [NestJS Server](https://github.com/nifty-lil-tricks/testing/blob/main/plugin_nestjs/README.md) | Setup a progressive Node.js framework for building efficient, reliable and scalable server-side applications for testing. || [![Latest Version](https://img.shields.io/npm/v/@nifty-lil-tricks/testing-plugin-nestjs?style=flat-square)](https://www.npmjs.com/package/@nifty-lil-tricks/testing-plugin-nestjs) | [Docs](https://github.com/nifty-lil-tricks/testing/blob/main/plugin_nestjs/README.md) |
| [Express Server](https://github.com/nifty-lil-tricks/testing/blob/main/plugin_express/README.md) | Setup a minimal and flexible Node.js web Express application for testing. | 🚧 | [![Latest Version](https://img.shields.io/npm/v/@nifty-lil-tricks/testing-plugin-express?style=flat-square)](https://www.npmjs.com/package/@nifty-lil-tricks/testing-plugin-express) | [Docs](https://github.com/nifty-lil-tricks/testing/blob/main/plugin_express/README.md) |

### Setup tests

Expand Down Expand Up @@ -268,7 +270,7 @@ The API Docs can be found [here](https://deno.land/x/nifty_lil_tricks_testing).
## Examples

Examples can be found
[here](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/examples/).
[here](https://github.com/nifty-lil-tricks/testing/blob/main/examples/).

## Support

Expand All @@ -282,27 +284,27 @@ Examples can be found
## Useful links

- For help or feedback on this project, join us in
[GitHub Discussions](https://github.com/jonnydgreen/nifty-lil-tricks-testing/discussions)
[GitHub Discussions](https://github.com/nifty-lil-tricks/testing/discussions)

## License

Nifty li'l tricks packages are 100% free and open-source, under the
[MIT license](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/LICENSE).
[MIT license](https://github.com/nifty-lil-tricks/testing/blob/main/LICENSE).

This package is [Treeware](https://treeware.earth). If you use it in production,
then we ask that you
[**buy the world a tree**](https://plant.treeware.earth/jonnydgreen/nifty-lil-tricks-testing)
[**buy the world a tree**](https://plant.treeware.earth/nifty-lil-tricks/testing)
to thank us for our work. By contributing to the Treeware forest you’ll be
creating employment for local families and restoring wildlife habitats.

## Contributions

[Contributions](https://github.com/jonnydgreen/nifty-lil-tricks-testing/blob/main/CONTRIBUTING.md),
[Contributions](https://github.com/nifty-lil-tricks/testing/blob/main/CONTRIBUTING.md),
issues and feature requests are very welcome. If you are using this package and
fixed a bug for yourself, please consider submitting a PR!

<p align="center">
<a href="https://github.com/jonnydgreen/nifty-lil-tricks-testing/graphs/contributors">
<img src="https://contrib.rocks/image?repo=jonnydgreen/nifty-lil-tricks-testing&columns=8" />
<a href="https://github.com/nifty-lil-tricks/testing/graphs/contributors">
<img src="https://contrib.rocks/image?repo=nifty-lil-tricks/testing&columns=8" />
</a>
</p>
Loading

0 comments on commit 115f463

Please sign in to comment.