feat(ci-cd): initial repo setup

gh-00

Author: yeshamavani

.czferc.js

@@ -0,0 +1,176 @@
+const types = [
+  {value: 'feat', name: 'feat:     A new feature'},
+  {value: 'fix', name: 'fix:      A bug fix'},
+  {value: 'docs', name: 'docs:     Documentation only changes'},
+  {
+    value: 'style',
+    name: 'style:    Changes that do not affect the meaning of the code\n            (white-space, formatting, missing semi-colons, etc)',
+  },
+  {
+    value: 'refactor',
+    name: 'refactor: A code change that neither fixes a bug nor adds a feature',
+  },
+  {
+    value: 'perf',
+    name: 'perf:     A code change that improves performance',
+  },
+  {value: 'test', name: 'test:     Adding missing tests'},
+  {
+    value: 'chore',
+    name: 'chore:    Changes to the build process or auxiliary tools\n            and libraries such as documentation generation',
+  },
+  {value: 'revert', name: 'revert:   Revert to a commit'},
+  {value: 'WIP', name: 'WIP:      Work in progress'},
+];
+
+const scopes = [
+  {name: 'chore'},
+  {name: 'ci-cd'},
+  {name: 'core'},
+  {name: 'styles'},
+  {name: 'auth'},
+  {name: 'theme'},
+  {name: 'shared'},
+];
+
+/**
+ * @typedef {{type: string; scope: string; subject: string; body: string; isBreaking: boolean; breakingBody: string; breaking: string; isIssueAffected: boolean; issuesBody: string; issues: string;}} Answers
+ */
+
+/** @type import('cz-format-extension').Config<Answers> */
+module.exports = {
+  questions({inquirer, gitInfo}) {
+    let migrationQuestions = getMigrationChanges(gitInfo.staged);
+    return [
+      {
+        type: 'list',
+        name: 'type',
+        message: 'Select type',
+        choices: types,
+      },
+      {
+        type: 'list',
+        name: 'scope',
+        message: 'Denote the SCOPE of this change (optional):\n',
+        choices: scopes,
+      },
+      {
+        type: 'input',
+        name: 'subject',
+        message: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
+        validate: subject =>
+          subject.length === 0 ? 'subject is required' : true,
+      },
+      ...migrationQuestions,
+      {
+        type: 'input',
+        name: 'body',
+        message:
+          'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+      },
+      {
+        type: 'input',
+        name: 'breaking',
+        message: 'List any BREAKING CHANGES (optional):\n',
+      },
+      {
+        type: 'input',
+        name: 'issues',
+        message:
+          'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+        filter: (input, answers) => {
+          return input.replace(/^\#/g, 'gh-');
+        },
+      },
+      {
+        type: 'expand',
+        name: 'confirmCommit',
+        choices: [
+          {key: 'y', name: 'Yes', value: 'yes'},
+          {key: 'n', name: 'Abort commit', value: 'no'},
+        ],
+        default: 0,
+        message(answers) {
+          const SEP =
+            '###--------------------------------------------------------###';
+          console.log(`\n${SEP}\n${buildCommit({answers, gitInfo})}\n${SEP}\n`);
+          return 'Are you sure you want to proceed with the commit above?';
+        },
+      },
+    ];
+  },
+  commitMessage({answers, gitInfo}) {
+    if (answers.confirmCommit === 'yes') {
+      return buildCommit({answers, gitInfo});
+    } else {
+      throw Error('Commit cancelled.');
+    }
+  },
+};
+
+function buildCommit({answers, gitInfo}) {
+  const migrationKeys = Object.keys(answers).filter(q =>
+    q.includes('migration-'),
+  );
+  const migrationAnswers = migrationKeys
+    .map(key => `${key}- ${answers[key]}`)
+    .join('\n');
+  const migrations =
+    migrationAnswers && migrationAnswers.length > 0
+      ? `MIGRATION CHANGE:\n${migrationAnswers}`
+      : false;
+  const scope = answers.scope ? `(${answers.scope})` : false;
+  const head = `${answers.type}${scope}: ${answers.subject}`;
+  const body = answers.body ? answers.body : false;
+  const breaking = answers.breaking
+    ? `BREAKING CHANGE:\n${answers.breaking}`
+    : false;
+  const issues = answers.issues
+    ? answers.issues.split(', ').join('\n').valueOf()
+    : false;
+
+  return escapeSpecialChars(
+    [head, body, migrations, breaking, issues].filter(p => p).join('\n\n'),
+  );
+}
+
+function getMigrationChanges(staged) {
+  let migrationPaths = staged
+    .map(
+      filePath =>
+        filePath.includes('migrations/') && filePath.split(/\//).pop(),
+    )
+    .filter(f => f && f.length > 0);
+  let timestamps = {};
+  for (let item of migrationPaths) {
+    let match = item.match(/[0-9]{14}/g);
+    if (match && match[0]) {
+      timestamps[match[0]] = [...(timestamps[match[0]] || []), item];
+    }
+  }
+  let questions = [];
+  Object.keys(timestamps).forEach(timestamp => {
+    questions.push({
+      type: 'input',
+      name: `migration-${timestamp}`,
+      message: `Write a description of the changes in migrations for timestamp - ${timestamp}:\n`,
+      validate: description =>
+        description.length === 0 ? 'description is required' : true,
+    });
+  });
+  return questions;
+}
+
+const escapeSpecialChars = result => {
+  // eslint-disable-next-line no-useless-escape
+  const specialChars = ['`'];
+
+  let newResult = result;
+  // eslint-disable-next-line array-callback-return
+  specialChars.map(item => {
+    // If user types "feat: `string`", the commit preview should show "feat: `\string\`".
+    // Don't worry. The git log will be "feat: `string`"
+    newResult = result.replace(new RegExp(item, 'g'), '\\`');
+  });
+  return newResult;
+};

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at support@sourcefuse.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# loopback4-microservice-catalog
+
+## Contributing
+
+First off, thank you for considering contributing to the project. It's people like you that helps in keeping this extension useful.
+
+### Where do I go from here ?
+
+If you've noticed a bug or have a question, [search the issue tracker](https://github.com/sourcefuse/angular-boilerplate/issues) to see if
+someone else in the community has already created a ticket. If not, go ahead and
+[make one](https://github.com/sourcefuse/angular-boilerplate/issues/new/choose)!
+
+### Fork & create a branch
+
+If this is something you think you can fix, then [fork](https://help.github.com/articles/fork-a-repo) this repo and
+create a branch with a descriptive name.
+
+A good branch name would be (where issue #325 is the ticket you're working on):
+
+```sh
+git checkout -b 325-add-new-feature
+```
+
+### Make a Pull Request
+
+At this point, you should switch back to your master branch and make sure it's
+up to date with loopback4-microservice-catalog's master branch:
+
+```sh
+git remote add upstream git@github.com:sourcefuse/angular-boilerplate.git
+git checkout master
+git pull upstream master
+```
+
+Then update your feature branch from your local copy of master, and push it!
+
+```sh
+git checkout 325-add-new-feature
+git rebase master
+git push --set-upstream origin 325-add-new-feature
+```
+
+Finally, go to GitHub and [make a Pull Request](https://help.github.com/articles/creating-a-pull-request).
+
+### Keeping your Pull Request updated
+
+If a maintainer asks you to "rebase" your PR, they're saying that a lot of code
+has changed, and that you need to update your branch so it's easier to merge.
+
+To learn more about rebasing in Git, there are a lot of [good][git rebasing]
+[resources][interactive rebase] but here's the suggested workflow:
+
+```sh
+git checkout 325-add-new-feature
+git pull --rebase upstream master
+git push --force-with-lease 325-add-new-feature
+```
+
+[git rebasing]: http://git-scm.com/book/en/Git-Branching-Rebasing
+[interactive rebase]: https://help.github.com/articles/interactive-rebase

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,30 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Intermediate change (work in progress)
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+## Checklist:
+
+- [ ] Performed a self-review of my own code
+- [ ] npm test passes on your machine
+- [ ] New tests added or existing tests modified to cover all changes
+- [ ] Code conforms with the style guide
+- [ ] API Documentation in code was updated
+- [ ] Any dependent changes have been merged and published in downstream modules

.github/semantic.yml

@@ -0,0 +1,2 @@
+titleAndCommits: true
+anyCommit: true