Skip to content

Commit dbd723b

Browse files
authored
Merge pull request #6 from swade1987/next
Next release
2 parents 5084845 + 0e96a3f commit dbd723b

14 files changed

+290
-207
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Description
2+
<!--- Describe your changes in detail -->
3+
4+
## Motivation and Context
5+
<!--- Why is this change required? What problem does it solve? -->
6+
<!--- If it fixes an open issue, please link to the issue here. -->
7+
<!--- If it works towards an open issue, please link to the issue here. -->
8+
9+
## How has this been tested?
10+
11+
## Types of changes
12+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
16+
17+
## Checklist:
18+
- [ ] My change requires a change to the documentation.
19+
- [ ] I have updated the documentation accordingly.
20+
- [ ] I've read the [CONTRIBUTION](https://github.com/swade1987/flux2-kustomize-template/blob/main/CONTRIBUTING.md) guide
21+
- [ ] I have signed-off my commits with `git commit -s`

.github/workflows/commit-lint.yaml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: commit-lint
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
10+
permissions:
11+
contents: read
12+
pull-requests: read
13+
14+
jobs:
15+
commit-lint:
16+
name: commit-lint
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
20+
- uses: wagoid/commitlint-github-action@3d28780bbf0365e29b144e272b2121204d5be5f3 # v6

.github/workflows/pr-lint.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: pr-lint
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- synchronize
9+
10+
permissions:
11+
contents: read
12+
pull-requests: read
13+
14+
jobs:
15+
lint:
16+
name: pr-lint
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5
20+
env:
21+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Create Release
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- next
8+
9+
jobs:
10+
release:
11+
name: release
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: write # to be able to publish a GitHub release
15+
issues: write # to be able to comment on released issues
16+
pull-requests: write # to be able to comment on released pull requests
17+
id-token: write # to enable use of OIDC for npm provenance
18+
steps:
19+
- name: checkout
20+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
21+
with:
22+
fetch-depth: 0
23+
persist-credentials: false
24+
token: ${{ secrets.RELEASE_TOKEN }}
25+
- name: setup node.js
26+
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4
27+
with:
28+
node-version: "lts/*"
29+
- name: release
30+
uses: cycjimmy/semantic-release-action@v4
31+
env:
32+
GITHUB_TOKEN: ${{ secrets.RELEASE_TOKEN }}

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea

.pre-commit-config.yaml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
default_install_hook_types:
2+
- pre-commit
3+
- commit-msg
4+
5+
repos:
6+
- repo: https://github.com/pre-commit/pre-commit-hooks
7+
rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b # SHA for v5.0.0
8+
hooks:
9+
- id: check-merge-conflict
10+
- id: end-of-file-fixer
11+
- id: trailing-whitespace
12+
- repo: https://github.com/compilerla/conventional-pre-commit
13+
rev: 5f9c312d9978fbcee1da97154ba385834eeda799 # SHA for v4.0.0
14+
hooks:
15+
- id: conventional-pre-commit
16+
stages: [commit-msg]
17+
args: [] # optional: list of Conventional Commits types to allow e.g. [feat, fix, ci, chore, test]

.releaserc

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"plugins": [
3+
"@semantic-release/github",
4+
"@semantic-release/commit-analyzer",
5+
"@semantic-release/release-notes-generator",
6+
],
7+
"branches": [
8+
{
9+
"name": "main"
10+
},
11+
{
12+
"name": "next",
13+
"prerelease": true
14+
}
15+
]
16+
}

CHANGELOG.md

Whitespace-only changes.

CONTRIBUTING.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing
2+
3+
The repository is [MIT licensed](https://github.com/swade1987/flux2-kustomize-template/blob/main/LICENSE) and
4+
accepts contributions via GitHub pull requests. This document outlines
5+
some of the conventions on to make it easier to get your contribution
6+
accepted.
7+
8+
We gratefully welcome improvements to issues and documentation as well as to
9+
code.
10+
11+
## Certificate of Origin
12+
13+
By contributing to the repository you agree to the Developer Certificate of
14+
Origin (DCO). This document was created by the Linux Kernel community and is a
15+
simple statement that you, as a contributor, have the legal right to make the
16+
contribution.
17+
18+
We require all commits to be signed. By signing off with your signature, you
19+
certify that you wrote the patch or otherwise have the right to contribute the
20+
material by the rules of the [DCO](DCO):
21+
22+
`Signed-off-by: Jane Doe <[email protected]>`
23+
24+
The signature must contain your real name
25+
(sorry, no pseudonyms or anonymous contributions)
26+
If your `user.name` and `user.email` are configured in your Git config,
27+
you can sign your commit automatically with `git commit -s`.
28+
29+
## Acceptance policy
30+
31+
These things will make a PR more likely to be accepted:
32+
33+
- a well-described requirement
34+
- sign-off all your commits
35+
- tests for new configuration
36+
- tests for old configuration!
37+
38+
In general, we will merge a PR once one maintainer has endorsed it.
39+
For substantial changes, more people may become involved, and you might
40+
get asked to resubmit the PR or divide the changes into more than one PR.
41+
42+
### Commit Message and Pull Request Requirements:
43+
44+
This repository enforces the `Conventional Commits` specification for both commit messages and pull request titles.
45+
46+
All commits and PR titles must follow this format:
47+
type(optional scope): description
48+
49+
Examples:
50+
- `feat: add new istio validation check`
51+
- `fix(ci): resolve kubeconform pipeline error`
52+
- `docs: update deployment instructions`
53+
- `chore: bump pre-commit hooks version`
54+
55+
The type must be one of: `build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test`
56+
57+
For more details on Conventional Commits, see: https://www.conventionalcommits.org/
58+
59+
Note: This is enforced automatically via GitHub Actions and pre-commit hooks.

DCO

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
660 York Street, Suite 102,
6+
San Francisco, CA 94110 USA
7+
8+
Everyone is permitted to copy and distribute verbatim copies of this
9+
license document, but changing it is not allowed.
10+
11+
12+
Developer's Certificate of Origin 1.1
13+
14+
By making a contribution to this project, I certify that:
15+
16+
(a) The contribution was created in whole or in part by me and I
17+
have the right to submit it under the open source license
18+
indicated in the file; or
19+
20+
(b) The contribution is based upon previous work that, to the best
21+
of my knowledge, is covered under an appropriate open source
22+
license and I have the right under that license to submit that
23+
work with modifications, whether created in whole or in part
24+
by me, under the same open source license (unless I am
25+
permitted to submit under a different license), as indicated
26+
in the file; or
27+
28+
(c) The contribution was provided directly to me by some other
29+
person who certified (a), (b) or (c) and I have not modified
30+
it.
31+
32+
(d) I understand and agree that this project and the contribution
33+
are public and that a record of the contribution (including all
34+
personal information I submit with it, including my sign-off) is
35+
maintained indefinitely and may be redistributed consistent with
36+
this project or the open source license(s) involved.

0 commit comments

Comments
 (0)