devsecops-ship-it v0.0.3

Ship It! 🚀

🚀 Collection of tools that performs git hooks management for linting, code formating, commit message standardization, sutomated versioning and package publishing

• husky: Tool that adds scripts (hooks) trigged before (pre-commit) and after (post-commit) your commit.
• commitizen: Tool that guides the developer through the writing of the commit message
• commitlint: Tool that validates the commit message following a set of rules and good practices
• prettier: An opinionated code formatter
• lint-staged: Run linters against staged git files and don't let :poop: slip into your code base!
• pre-commit: A framework for managing and maintaining multi-language pre-commit hooks

Prerequisites

1. Set up your environment. Follow the steps in the Quick Start: snap-it shellproject. The steps include:

   - npm       - v7.6.0
   - Nodejs    - v15.10.0
   - python3   - v3.9.2

2. Clone this repository:

   git clone ghttps://github.com/rajasoun/ship-it
   cd ship-it

3. To enable husky, commitzen, commitlint, prettier and lint-staged

   npm install

4. To enable pre-commit (python based) and ggshield

   pip3 install pipenv
   pipenv shell
   pipenv install

5. Populate .env file with GITHUB_TOKEN, GITGUARDIAN_API_KEY and GITGUARDIAN_API_URL

   cp .env.sample .env