s-block

Template to kickstart creating a Node.js module using TypeScript and VSCode

Features

Semantic Release
[Issue Templates]
[GitHub Actions]
Codecov
[VSCode Launch Configurations]
TypeScript
Husky
Lint Staged
Commitizen
Jest
ESLint
Prettier

Getting started

Set up your repository

Replace FULL_NAME, GITHUB_USER, NODE_VERSION and REPO_NAME in the ./customize.sh script with your own details to personalize your new package:

FULL_NAME="John Smith"
GITHUB_USER="johnsmith"
REPO_NAME="my-cool-package"
NODE_VERSION="18.17.1"

Add permission to edit chmod +x ./customize.sh and rund it ./customize.sh

Add Tokens for NPM(Automation), Github, CodeCov

Add your npm token to your GitHub repository secrets as NPM_TOKEN, GH_TOKEN and CODECOV_TOKEN

Add Codecov integration

Enable the Codecov GitHub App here.

Remove everything from here and above

s-block

My awesome module

Install

npm install s-block

Usage

import { myPackage } from 's-block';

myPackage('hello');
//=> 'hello from my package'

API

myPackage(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string Default: rainbows

Lorem ipsum.

The automated release is failing 🚨

🚨 The automated release from the `main` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Cannot push to the Git repository.

semantic-release cannot push the version tag to the branch main on the remote Git repository with URL https://x-access-token:[secure]@github.com/SebastianWesolowski/s-block.git.

This can be caused by:

a misconfiguration of the repositoryUrl option
the repository being unavailable
or missing push permission for the user configured via the Git credentials on your CI environment

Good luck with your project ✨

Your semantic-release bot 📦🚀

sebastianwesolowski / s-block Goto Github PK

s-block's Introduction

s-block

Features

Getting started

Set up your repository

Add Tokens for NPM(Automation), Github, CodeCov

Add Codecov integration

s-block

Install

Usage

API

myPackage(input, options?)

input

options

postfix

s-block's People

Contributors

Watchers

s-block's Issues

🚨 The automated release from the main branch failed. 🚨

Cannot push to the Git repository.

Recommend Projects

Recommend Topics

Recommend Org

🚨 The automated release from the `main` branch failed. 🚨