Skip to content

Commit

Permalink
Dependency and governance upgrades
Browse files Browse the repository at this point in the history
- Upgraed dependencies.

- Improved governance documentation, mostly by adding it.

- Switched from eslint/prettier to Biome.

- Included action / version in the output.
  • Loading branch information
halostatue committed Feb 26, 2024
1 parent c942a85 commit 84f78c1
Show file tree
Hide file tree
Showing 16 changed files with 656 additions and 2,454 deletions.
14 changes: 12 additions & 2 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# KineticCafe/actions-dco Changelog

## 1.3 / 2023-02-28

- Upgraed dependencies.

- Improved governance documentation, mostly by adding it.

- Switched from eslint/prettier to Biome.

- Included action / version in the output.

## 1.2 / 2023-09-25

- Upgraded dependencies and set dependency on Node v20.
- Upgraded dependencies and set runtime as Node v20.

## 1.1 / 2023-07-21

Expand All @@ -14,4 +24,4 @@
## 1.0 / 2023-06-12

- Initial release. This is a Typescript port of tisonkun/actions-dco set
to use Node 16.
to use Node v16.
35 changes: 35 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing

We value contributions to @KineticCafe/actions-dco—bug reports, feature
requests, and code contributions.

Before contributing patches, please read the [Licence.md](./Licence.md).

@KineticCafe/actions-dco is governed under the Kinetic Commerce Open Source
[Code of Conduct][].

## Code Guidelines

Our usual code contribution guidelines apply:

- Code changes _will not_ be accepted without tests. The test suite is written
with [vitest][].
- Match our coding style. We use Biome to assist with this.
- Use a thoughtfully-named topic branch that contains your change. Rebase your
commits into logical chunks as necessary.
- Use [quality commit messages][].
- The version number must not be changed except as part of the release process.
- Submit a pull request with your changes.
- New or changed behaviours require new or updated documentation.

A pull request will be accepted only if all code quality checks performed in
GitHub Actions pass.

@KineticCafe/actions-dco is compiled into a single file with `@vercel/ncc` for
release. One of the status checks is that there are no changes during the
packaging process. Ensure that you run `pnpm all` and commit any files in
`dist/` once you are satisfied with your changes.

[code of conduct]: https://github.com/KineticCafe/code-of-conduct
[quality commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[vitest]: https://vitest.dev/
201 changes: 0 additions & 201 deletions LICENSE

This file was deleted.

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

@KineticCafe/actions-dco is copyright © 2023-2024 Kinetic Commerce and
contributors under the [Apache License, version 2.0][apache-license-20], except:

- The copies of the Apache Licence and the Developer Certificate of Origin in
`licenses/`.

## Developer Certificate of Origin

All contributors **must** certify they are able and willing to provide their
contributions under the terms of this project's licences with the certification
of the [Developer Certificate of Origin (Version 1.1)][dco].

Such certification is provided by ensuring that the following line must be
included as the last line of a commit message for every commit contributed:

Signed-off-by: FirstName LastName <[email protected]>

The `Signed-off-by` line can be automatically added by git with the `-s` or
`--signoff` option on `git commit`:

```sh
git commit --signoff
```

[apache-license-20]: licenses/APACHE-2.0.txt
[dco]: licenses/dco.txt
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,24 @@ jobs:
@example.com
```

## Contributing

@KineticCafe/actions-dco [welcomes contributions][]. This project, like all
Kinetic Commerce [open source projects][], is under the Kinetic Commerce Open
Source [Code of Conduct][].

This project is licensed under the Apache Licence, version 2.0 and requires
certification via a Developer Certificate of Origin. See [Licence.md][] for
more details.

## Releasing

Releases are prepared with `@vercel/ncc` to produce a single file which must
be committed to `dist/`. Run `pnpm package` or `pnpm all` to produce this
file.

[welcomes contributions]: https://github.com/KineticCafe/actions-dco/blob/main/Contributing.md
[code of conduct]: https://github.com/KineticCafe/code-of-conduct
[open source projects]: https://github.com/KineticCafe
[licence.md]: https://github.com/KineticCafe/actions-dco/blob/main/Licence.md
[dco]: https://developercertificate.org
28 changes: 28 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"$schema": "https://biomejs.dev/schemas/1.5.3/schema.json",
"files": {
"ignore": ["coverage/**", "dist/**", "docs/**", "lib/**"]
},
"organizeImports": {
"enabled": true
},
"formatter": {
"enabled": true,
"indentStyle": "space",
"lineWidth": 90
},
"javascript": {
"formatter": {
"indentStyle": "space",
"lineWidth": 90,
"quoteStyle": "single",
"semicolons": "asNeeded"
}
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
}
}
14 changes: 4 additions & 10 deletions dist/index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

25 changes: 0 additions & 25 deletions dist/licenses.txt

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 84f78c1

Please sign in to comment.