generated from ik-performance/performance-blueprint-project
-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 06ca8ee
Showing
20 changed files
with
507 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
{{ if .Versions -}} | ||
<a name="unreleased"></a> | ||
## [Unreleased] | ||
{{ if .Unreleased.CommitGroups -}} | ||
{{ range .Unreleased.CommitGroups -}} | ||
### {{ .Title }} | ||
{{ range .Commits -}} | ||
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} | ||
{{ end }} | ||
{{ end -}} | ||
{{ else }} | ||
{{ range .Unreleased.Commits -}} | ||
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} | ||
{{ end }} | ||
{{ end -}} | ||
{{ end -}} | ||
|
||
{{ range .Versions }} | ||
<a name="{{ .Tag.Name }}"></a> | ||
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }} | ||
{{ if .CommitGroups -}} | ||
{{ range .CommitGroups -}} | ||
### {{ .Title }} | ||
{{ range .Commits -}} | ||
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} | ||
{{ end }} | ||
{{ end -}} | ||
{{ else }} | ||
{{ range .Commits -}} | ||
- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} | ||
{{ end }} | ||
{{ end -}} | ||
|
||
{{- if .NoteGroups -}} | ||
{{ range .NoteGroups -}} | ||
### {{ .Title }} | ||
{{ range .Notes }} | ||
{{ .Body }} | ||
{{ end }} | ||
{{ end -}} | ||
{{ end -}} | ||
{{ end -}} | ||
|
||
{{- if .Versions }} | ||
[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD | ||
{{ range .Versions -}} | ||
{{ if .Tag.Previous -}} | ||
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }} | ||
{{ end -}} | ||
{{ end -}} | ||
{{ end -}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
style: github | ||
template: CHANGELOG.tpl.md | ||
info: | ||
title: CHANGELOG | ||
repository_url: https://github.com/ik-performance/performance-blueprint-project.git | ||
options: | ||
header: | ||
pattern: "^(.*)$" | ||
pattern_maps: | ||
- Subject |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# top-most EditorConfig file | ||
root = true | ||
|
||
[*] | ||
end_of_line = lf | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 2 | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
# GIT | ||
[COMMIT_EDITMSG] | ||
indent_size = 4 | ||
indent_style = space | ||
max_line_length = 80 | ||
|
||
[*.patch] | ||
trim_trailing_whitespace = false | ||
|
||
[{*.conf}] | ||
indent_size = 2 | ||
max_line_length = 100 | ||
|
||
# Bash Files | ||
[*.sh] | ||
end_of_line = lf | ||
|
||
# Tab indentation (no size specified) | ||
[Makefile] | ||
indent_style = tab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Code of Conduct for {project name} | ||
|
||
Please see the [Community Code of Conduct](https://www.finos.org/code-of-conduct). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Contributing to {project name} | ||
|
||
# Contributor License Agreement (CLA) | ||
A CLA is a document that specifies how a project is allowed to use your | ||
contribution; they are commonly used in many open source projects. | ||
|
||
**_All_ contributions to _all_ projects hosted by [FINOS](https://www.finos.org/) | ||
must be made with a | ||
[Foundation CLA](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/83034172/Contribute) | ||
in place, and there are [additional legal requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Legal+Requirements) | ||
that must also be met.** | ||
|
||
Commits and pull requests to FINOS repositories such as {project name} will only be accepted from those contributors with an active, executed Individual Contributor License Agreement (ICLA) with FINOS OR who are covered under an existing and active Corporate Contribution License Agreement (CCLA) executed with FINOS. Commits from individuals not covered under an ICLA or CCLA will be flagged and blocked by the FINOS ["CLA Bot" tool](https://github.com/finos/cla-bot). Please note that some CCLAs require individuals/employees to be explicitly named on the CCLA. | ||
|
||
As a result, PRs submitted to the {project name} project cannot be accepted until you have a CLA in place with the Foundation. | ||
|
||
Need an ICLA? Unsure if you are covered under an existing CCLA? Email [[email protected]](mailto:[email protected]?subject=CLA) | ||
|
||
# Contributing Issues | ||
|
||
## Prerequisites | ||
|
||
* [ ] Have you [searched for duplicates](https://github.com/{program name}/{project name}/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice. | ||
* [ ] Are you running the latest version? | ||
* [ ] Are you sure this is a bug or missing capability? | ||
|
||
## Raising an Issue | ||
* Create your issue [here](https://github.com/{program name}/{project name}/issues/new). | ||
* New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, **then delete the other**. | ||
* Please also tag the new issue with either "Bug" or "Enhancement". | ||
* Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/) | ||
liberally to assist in readability. | ||
* [Code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for exception stack traces and log entries, for example, massively improve readability. | ||
|
||
# Contributing Pull Requests (Code & Docs) | ||
To make review of PRs easier, please: | ||
|
||
* Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted. | ||
* For code contributions, follow the existing code layout. | ||
* For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/{program name}/{project name}/wiki). | ||
* Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too). | ||
* Reference issue #s if your PR has anything to do with an issue (even if it doesn't address it). | ||
* Minimise non-functional changes (e.g. whitespace). | ||
* Ensure all new files include a header comment block containing the [Apache License v2.0 and your copyright information](http://www.apache.org/licenses/LICENSE-2.0#apply). | ||
* If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/{program name}/{project name}/blob/master/NOTICE) with any new attribution or other notices | ||
|
||
|
||
## Commit and PR Messages | ||
|
||
* **Reference issues, wiki pages, and pull requests liberally!** | ||
* Use the present tense ("Add feature" not "Added feature") | ||
* Use the imperative mood ("Move button left..." not "Moves button left...") | ||
* Limit the first line to 72 characters or less |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# These are supported funding model platforms | ||
|
||
github: [ivankatliarchuk] | ||
patreon: # Replace with a single Patreon username | ||
open_collective: # Replace with a single Open Collective username | ||
ko_fi: # Replace with a single Ko-fi username | ||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
liberapay: # Replace with a single Liberapay username | ||
issuehunt: # Replace with a single IssueHunt username | ||
otechie: # Replace with a single Otechie username | ||
custom: https://paypal.me/ivankatliarchuk |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: 🐛 Bug Report | ||
about: If something isn't working as expected 🤔. | ||
|
||
--- | ||
|
||
## Bug Report | ||
|
||
### Steps to Reproduce: | ||
1. ...step 1 description... | ||
2. ...step 2 description... | ||
3. ...step 3 description... | ||
|
||
### Expected Result: | ||
...description of what you expected to see... | ||
|
||
### Actual Result: | ||
...what actually happened, including full exceptions (please include the entire stack trace, including "caused by" entries), log entries, screen shots etc. where appropriate... | ||
|
||
### Environment: | ||
...version and build of the project, OS and runtime versions, virtualised environment (if any), etc. ... | ||
|
||
### Additional Context: | ||
...add any other context about the problem here. If applicable, add screenshots to help explain... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
name: 🚀 Feature Request | ||
about: I have a suggestion (and may want to implement it 🙂)! | ||
|
||
--- | ||
|
||
## Feature Request | ||
|
||
### Description of Problem: | ||
...what *problem* are you trying to solve that the project doesn't currently solve? | ||
|
||
...please resist the temptation to describe your request in terms of a solution. Job Story form ("When [triggering condition], I want to [motivation/goal], so I can [outcome].") can help ensure you're expressing a problem statement. | ||
|
||
### Potential Solutions: | ||
...clearly and concisely describe what you want to happen. Add any considered drawbacks. | ||
|
||
... if you've considered alternatives, clearly and concisely describe those too. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
name: 🤗 Support Question | ||
about: If you have a question about configuration, usage, etc. 💬 | ||
|
||
--- | ||
|
||
## Support Question | ||
|
||
...ask your question here. | ||
|
||
...be sure to search existing issues since someone might have already asked something similar. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: pre-commit-validate | ||
# This workflow is triggered on pushes to the repository. | ||
on: [push, pull_request] | ||
|
||
jobs: | ||
validation: | ||
name: pre-commit-validate | ||
runs-on: macOS-latest | ||
steps: | ||
- uses: actions/checkout@master | ||
with: | ||
fetch-depth: '1' | ||
- name: Install Deps | ||
run: | | ||
brew install pre-commit shellcheck | ||
- name: Check All Files | ||
run: | | ||
pre-commit run --all-files |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
name: release | ||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
env: | ||
WITH_V: true | ||
DEFAULT_BUMP: patch | ||
|
||
jobs: | ||
build: | ||
name: release new version | ||
runs-on: ubuntu-latest | ||
if: "!contains(github.event.head_commit.message, 'skip')" | ||
steps: | ||
- uses: actions/checkout@master | ||
with: | ||
fetch-depth: '1' | ||
|
||
- name: register values | ||
id: register | ||
run: | | ||
echo "::set-output name=release_timestamp::$(date +%Y-%m-%d_%H.%m)" | ||
echo "::set-output name=tag_hash::${GITHUB_SHA::8}" | ||
echo "::set-output name=changelog::$(git log -1 --pretty=format:"%s")" | ||
- name: Bump version and push tag | ||
uses: anothrNick/[email protected] | ||
id: tag | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: create release | ||
id: create_release | ||
uses: actions/[email protected] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
with: | ||
tag_name: ${{ steps.tag.outputs.tag }} | ||
release_name: release ${{ steps.register.outputs.release_timestamp}} | ||
draft: false | ||
prerelease: false | ||
body: | | ||
Changes in this Release ${{ steps.register.outputs.changelog }} | ||
- ${{ steps.register.outputs.changelog }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
|
||
# Created by https://www.gitignore.io/api/git,visualstudiocode,macos | ||
# Edit at https://www.gitignore.io/?templates=git,visualstudiocode,macos | ||
|
||
### Git ### | ||
# Created by git for backups. To disable backups in Git: | ||
# $ git config --global mergetool.keepBackup false | ||
*.orig | ||
|
||
# Created by git when using merge tools for conflicts | ||
*.BACKUP.* | ||
*.BASE.* | ||
*.LOCAL.* | ||
*.REMOTE.* | ||
*_BACKUP_*.txt | ||
*_BASE_*.txt | ||
*_LOCAL_*.txt | ||
*_REMOTE_*.txt | ||
|
||
### macOS ### | ||
# General | ||
.DS_Store | ||
.AppleDouble | ||
.LSOverride | ||
|
||
# Icon must end with two \r | ||
Icon | ||
|
||
# Thumbnails | ||
._* | ||
|
||
# Files that might appear in the root of a volume | ||
.DocumentRevisions-V100 | ||
.fseventsd | ||
.Spotlight-V100 | ||
.TemporaryItems | ||
.Trashes | ||
.VolumeIcon.icns | ||
.com.apple.timemachine.donotpresent | ||
|
||
# Directories potentially created on remote AFP share | ||
.AppleDB | ||
.AppleDesktop | ||
Network Trash Folder | ||
Temporary Items | ||
.apdisk | ||
|
||
### VisualStudioCode ### | ||
.vscode/* | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/launch.json | ||
!.vscode/extensions.json | ||
|
||
### VisualStudioCode Patch ### | ||
# Ignore all local history of files | ||
.history | ||
|
||
# End of https://www.gitignore.io/api/git,visualstudiocode,macos |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
repos: | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v3.1.0 | ||
hooks: | ||
- id: check-added-large-files | ||
args: ['--maxkb=500'] | ||
- id: check-executables-have-shebangs | ||
- id: pretty-format-json | ||
args: ['--autofix', '--no-sort-keys', '--indent=2'] | ||
- id: check-byte-order-marker | ||
- id: check-case-conflict | ||
- id: check-executables-have-shebangs | ||
- id: check-merge-conflict | ||
- id: check-symlinks | ||
- id: detect-private-key | ||
- id: check-merge-conflict | ||
- id: detect-aws-credentials | ||
args: ['--allow-missing-credentials'] | ||
- repo: git://github.com/smian/pre-commit-makefile | ||
rev: 261f8fb4b31dfdc05d1a1d7fbde1f1462ecde66d | ||
hooks: | ||
- id: makefile-doc | ||
- repo: https://github.com/gruntwork-io/pre-commit | ||
rev: v0.1.5 # Get the latest from: https://github.com/gruntwork-io/pre-commit/releases | ||
hooks: | ||
- id: shellcheck | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<a name="unreleased"></a> | ||
## [Unreleased] | ||
|
||
|
||
|
||
<a name="v0.1.0"></a> | ||
## v0.1.0 - 2020-05-24 | ||
|
||
- initial version | ||
- Initial commit | ||
|
||
|
||
[Unreleased]: https://github.com/ik-performance/performance-blueprint-project.git/compare/v0.1.0...HEAD |
Oops, something went wrong.