-
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.
extracted from @hello.nrfcloud.com/backend
- Loading branch information
0 parents
commit 5da322b
Showing
26 changed files
with
5,183 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 @@ | ||
* @coderbyheart |
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,37 @@ | ||
name: Test and Release | ||
|
||
on: push | ||
|
||
permissions: | ||
contents: write | ||
issues: write | ||
|
||
env: | ||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
jobs: | ||
tests: | ||
runs-on: ubuntu-22.04 | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-node@v4 | ||
with: | ||
node-version: "20.x" | ||
cache: "npm" | ||
- name: Authenticate with NPM registry | ||
run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc | ||
- name: Install dependencies | ||
run: npm ci --no-audit | ||
- name: Compile | ||
run: npx tsc | ||
- name: Check source code with eslint | ||
run: npx eslint . | ||
- name: Check if source code is properly formatted | ||
run: npx prettier -c ./ | ||
- name: Test | ||
run: npm test | ||
- name: Semantic release | ||
continue-on-error: true | ||
run: npx semantic-release |
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,32 @@ | ||
name: Sync repository info from package.json | ||
|
||
env: | ||
GITHUB_TOKEN: ${{ secrets.UPDATE_REPO_INFO_PAT }} | ||
|
||
on: | ||
push: | ||
branches: | ||
- saga | ||
paths: | ||
- "package.json" | ||
- ".github/workflows/update-repo-info.yaml" | ||
workflow_dispatch: | ||
|
||
jobs: | ||
update_repo_info: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Sync repository description | ||
run: | ||
gh repo edit --description "`cat package.json | jq -r '.description'`" | ||
|
||
- name: Sync repository topics | ||
run: | ||
cat package.json | jq '.keywords[]' | xargs -I'{}' gh repo edit | ||
--add-topic {} | ||
|
||
- name: Sync homepage | ||
run: gh repo edit --homepage "`cat package.json | jq -r '.homepage'`" |
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 @@ | ||
node_modules/ | ||
npm-debug.log | ||
dist/ |
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 @@ | ||
npx commitlint --edit $1 |
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,2 @@ | ||
npx lint-staged | ||
npm test |
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,2 @@ | ||
dist/ | ||
package-lock.json |
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 @@ | ||
See <https://github.com/bifravst/.github/blob/saga/CODE_OF_CONDUCT.md> |
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 @@ | ||
See <https://github.com/bifravst/.github/blob/saga/CONTRIBUTING.md> |
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,29 @@ | ||
BSD 3-Clause License | ||
|
||
Copyright (c) 2024, Nordic Semiconductor ASA | nordicsemi.no | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, this | ||
list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, | ||
this list of conditions and the following disclaimer in the documentation | ||
and/or other materials provided with the distribution. | ||
|
||
3. Neither the name of the copyright holder nor the names of its | ||
contributors may be used to endorse or promote products derived from | ||
this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE | ||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
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,15 @@ | ||
# Step definitions for BDD Markdown [![npm version](https://img.shields.io/npm/v/@hello.nrfcloud.com/bdd-markdown-steps.svg)](https://www.npmjs.com/package/@hello.nrfcloud.com/bdd-markdown-steps) | ||
|
||
[![GitHub Actions](https://github.com/hello-nrfcloud/bdd-markdown-steps/workflows/Test%20and%20Release/badge.svg)](https://github.com/hello-nrfcloud/bdd-markdown-steps/actions) | ||
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) | ||
[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com) | ||
[![@commitlint/config-conventional](https://img.shields.io/badge/%40commitlint-config--conventional-brightgreen)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional) | ||
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier/) | ||
[![ESLint: TypeScript](https://img.shields.io/badge/ESLint-TypeScript-blue.svg)](https://github.com/typescript-eslint/typescript-eslint) | ||
|
||
Step definitions for | ||
[BDD Markdown](https://github.com/NordicSemiconductor/bdd-markdown-js). | ||
|
||
## Installation | ||
|
||
npm i --save --save-exact @hello.nrfcloud.com/bdd-markdown-steps |
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 @@ | ||
# ADR 001: Use saga as the name for the main branch | ||
|
||
Historically, Git and other software use terms such as `master/slave`, | ||
`whitelist/blacklist`, which are based on racial concepts. Their continued use | ||
maintains the racial stereotypes they depict. Better alternatives in meaning and | ||
technical correctness exist, like `leader/follower`, `blocklist/allowlist`. | ||
|
||
In the Nordic mythology, a `saga` is a long, continuous recollection of stories | ||
about the history of humans, legends, and Gods. The term `saga` reflects very | ||
well what happens in a Git repository. Changes happen in branches (some teams | ||
tie them to _User Stories_, which are sometimes directly or loosely coupled to | ||
the main branch). Once the changes are finalized, they get added to the main | ||
branch, or get appended in the case of a rebase. The mental model of a big book | ||
of stories fits this process very well. | ||
|
||
Therefore, the main branch in this project is named `saga`. `master` must not be | ||
used. |
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,8 @@ | ||
# ADR 002: Clean `.gitignore` file | ||
|
||
A `.gitignore` file in a project must only cover the artifacts caused by the | ||
contained source code and not those caused by the personal choice of editor or | ||
the environment of a developer. | ||
|
||
This is explained in detail | ||
[here](https://github.com/coderbyheart/first-principles/issues/30). |
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 @@ | ||
# ADR 003: use of TypeScript | ||
|
||
This project is developed using [TypeScript](https://www.typescriptlang.org/) (a | ||
typed superset of JavaScript). | ||
|
||
JavaScript is the most popular language according to the | ||
[2019 Stack Overflow survey](https://insights.stackoverflow.com/survey/2019#technology) | ||
and it is therefore likely that many developers using the project will be | ||
familiar with the language concepts and how to use and run it. | ||
|
||
Virtually all cloud providers provide their SDKs in JavaScript or TypeScript | ||
which this project can integrate natively. |
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,8 @@ | ||
# Architecture decision records | ||
|
||
This folder contains the architecture decision records (ADRs) for this project. | ||
|
||
To know more about ADRs, see | ||
[Documenting architecture decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) | ||
and the video on | ||
[Communicating and documenting architectural decisions](https://www.youtube.com/watch?v=rwfXkSjFhzc). |
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 @@ | ||
module.exports = { extends: ["@commitlint/config-conventional"] }; |
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,2 @@ | ||
import config from '@bifravst/eslint-config-typescript' | ||
export default config |
Oops, something went wrong.