ci: Protex only scan main

Merge pull request #68 from open-amt-cloud-toolkit/rsdmike-patch-1
docs: add contributing guidelines
2022-03-10 09:13:41 -07:00 · 2021-10-11 15:12:31 -07:00 · 2021-10-09 13:51:32 -07:00 · 2021-10-09 13:51:19 -07:00 · 2021-10-09 11:44:58 -07:00 · 2021-10-09 11:44:45 -07:00
8 changed files with 128 additions and 5 deletions
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,16 @@
+## PR Checklist
+<!-- Please check if your PR fulfills the following requirements: -->
+
+- [ ] Unit Tests have been added for new changes
+- [ ] API tests have been updated if applicable
+- [ ] All commented code has been removed
+- [ ] If you've added a dependency, you've ensured license is compatible with Apache 2.0 and clearly outlined the added dependency.
+
+
+## What are you changing?
+<!-- Please provide a short description of the updates that are in the PR -->
+
+
+## Anything the reviewer should know when reviewing this PR?
+
+### If the there are associated PRs in other repositories, please link them here (i.e. open-amt-cloud-toolkit/repo#365 )
--- a/.github/workflows/changelog.yml
+++ b/.github/workflows/changelog.yml
@@ -2,7 +2,7 @@ name: Changelog Generator

 on:  
  pull_request:
-    branches: [ master ]
+    branches: [ main ]
  workflow_dispatch:
 jobs:
  build:
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -7,7 +7,7 @@ name: Build RPC (Native)

 on:
  pull_request:
-    branches: [ master ]
+    branches: [ main ]
   
 env:
  BUILD_TYPE: Release
--- a/.github/workflows/docker-ci.yml
+++ b/.github/workflows/docker-ci.yml
@@ -7,7 +7,7 @@ name: Docker Image CI

 on:
  push:
-      branches: [ master ]
+      branches: [ main ]
 jobs:
  build:
    runs-on: ubuntu-latest
--- a/CONTRIBUTING.MD
+++ b/CONTRIBUTING.MD
@@ -0,0 +1,101 @@
+## <a name="commit"></a> Commit Message Guidelines
+
+We have precise rules over how our git commit messages should be formatted. This leads to more readable messages that are easy to follow when looking through the project history.
+
+### Commit Message Format
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** with **type** is mandatory.  The **scope** of the header is optional as far as the automated PR checks are concerned, but be advised that PR reviewers **may request** you provide an applicable scope.
+
+Any line of the commit message should no be longer 72 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
+
+The footer should contain a reference to an Azure Boards ticket (e.g. AB#[number]).
+
+Example 1:
+```
+feat(telemetry): Add new MQTT events
+
+Events are now emitted over various /mps topics on MQTT for success/failures 
+as they occur throughout the service.
+
+Resolves: AB#2222
+```
+
+
+### Revert
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing tests or correcting existing tests
+* **build**: Changes that affect the CI/CD pipeline or build system or external dependencies (example scopes: travis, jenkins, makefile)
+* **ci**: Changes provided by DevOps for CI purposes.
+* **revert**: Reverts a previous commit.
+
+### Scope
+
+Should be one of the following:
+Modules:
+* **common**: A change or addition to the common module
+* **tracker**: A change or addition to the tracker module
+* **server**: A change or addition to the server module
+* **msgs**: A change or addition to msgs module
+* **eval**: Any change to benchmark tools
+* **deps**: A change to any dependency or 3rd-party library
+* **all**: A change that affects all modules
+* *no scope*:  If no scope is provided, it is assumed the PR does not apply to the above scopes
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+Here is detailed guideline on how to write the body of the commit message ([Reference](https://chris.beams.io/posts/git-commit/)):
+```
+More detailed explanatory text, if necessary. Wrap it to about 72
+characters or so. In some contexts, the first line is treated as the
+subject of the commit and the rest of the text as the body. The
+blank line separating the summary from the body is critical (unless
+you omit the body entirely); various tools like `log`, `shortlog`
+and `rebase` can get confused if you run the two together.
+
+Explain the problem that this commit is solving. Focus on why you
+are making this change as opposed to how (the code explains that).
+Are there side effects or other unintuitive consequences of this
+change? Here's the place to explain them.
+
+Further paragraphs come after blank lines.
+
+ - Bullet points are okay, too
+
+ - Typically a hyphen or asterisk is used for the bullet, preceded
+   by a single space, with blank lines in between, but conventions
+   vary here
+```
+
+### Footer
+
+The footer should contain a reference to JIRA ticket (e.g. SL6-0000) that this commit **Closes** or **Resolves**.
+The footer should contain any information about **Breaking Changes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
+
+
+### Pull Requests practices
+
+* PR author is responsible to merge its own PR after review has been done and CI has passed.
+* When merging, make sure git linear history is preserved. PR author should select a merge option (`Rebase and merge` or `Squash and merge`) based on which option will fit the best to the git linear history.
+* PR topic should follow the same guidelines as the header of the [Git Commit Message](#commit-message-format)
--- a/7
+++ b/7
@@ -24,6 +24,11 @@ pipeline {
                PROJECT_NAME               = 'OpenAMT - RPC'
                SCANNERS                   = 'protex'
            }
+            when {
+                anyOf {
+                    branch 'main';
+                }
+            }
            steps {
                rbheStaticCodeScan()
            }
@@ -151,4 +156,4 @@ pipeline {
            }
        }
    }
-}
+}
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ We leverage GitHub Actions as a means to build RPC automatically leveraging Gith

 3. Click the **Run Workflow** dropdown. 

-4. Select the **Branch: master**, or a preferred version, from the **Use workflow from** dropdown. 
+4. Select the **Branch: main**, or a preferred version, from the **Use workflow from** dropdown. 

 5. By default, the Build Type should be **release**.  

--- a/1
+++ b/1
Author	SHA1	Message	Date
Bill Mahoney	098ba37907	ci: Protex only scan main	2022-03-10 09:13:41 -07:00
Mike	2a2d6a807b	Merge pull request #68 from open-amt-cloud-toolkit/rsdmike-patch-1 docs: add contributing guidelines	2021-10-11 15:12:31 -07:00
Mike	6b7bbbf079	Merge branch 'main' into rsdmike-patch-1	2021-10-09 13:51:32 -07:00
Mike	2b3166dfa0	Merge pull request #67 from open-amt-cloud-toolkit/ci	2021-10-09 13:51:19 -07:00
Mike	926b8d7064	Merge branch 'main' into ci	2021-10-09 11:44:58 -07:00
Mike	62e0b4f037	Merge branch 'main' into rsdmike-patch-1	2021-10-09 11:44:45 -07:00
Mike	24b18f6422	docs(github): add pull request template	2021-10-04 11:39:23 -07:00
Mike	052dff7d6f	docs: add contributing guidelines closes AB#4121	2021-10-04 10:49:05 -07:00
Mike	2c4c42851d	ci: rename master to main for jobs	2021-09-29 11:58:53 -07:00