Merge pull request #1 from DevOps-MBSE/dev

aac-puml project infrastructure setup (#774)

.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.py,*.py.jinja2}]
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.proto,*.proto.jinja2}]
+indent_size = 2
+
+[*.y{ml,aml}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,6 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# These are explicitly windows files and should use crlf
+*.bat           text eol=crlf
+

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -0,0 +1,88 @@
+name: "🐛 PUML Bug Report"
+description: Create a new ticket for a bug in the PUML repository.
+title: "🐛 [PUML BUG] - <title>"
+labels: [
+  "bug"
+]
+projects: [
+  "DevOps-MBSE"
+]
+body:
+  - type: checkboxes
+    id: pre-requistes
+    attributes:
+      label: "Pre-requisites"
+      description: Please answer the following questions for yourself before submitting an issue.
+      options:
+      - label: I checked the documentation and found no answer.
+        required: true
+      - label: I checked to make sure that this issue has not already been filed.
+        required: true
+  - type: input
+    id: version-pre-req
+    attributes:
+      label: "What version of AaC are you using? Check your version with the command: aac version."
+      placeholder: i.e. 0.1.7
+    validations:
+      required: true
+  - type: input
+    id: plugin-version-pre-req
+    attributes:
+      label: "What version of the plugin are you using?"
+      placeholder: i.e. 0.1.7
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      placeholder: Please enter a short and explicit description of your incident.
+    validations:
+      required: true
+  - type: input
+    id: reproduction-url
+    attributes:
+      label: "Reproduction URL"
+      placeholder: ex. https://github.com/USERNAME/REPO-NAME
+    validations:
+      required: false
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: "Reproduction steps"
+      value: |
+        Please enter an explicit description of your issue
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      value: |
+        If applicable, add screenshots to help explain your problem.
+        ![DESCRIPTION](LINK.png)
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Logs"
+      value: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: files
+    attributes:
+      label: "Pertinent Files"
+      value: |
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/DOCUMENTATION-REQUEST.yml

@@ -0,0 +1,33 @@
+name: "✏️📘 PUML Documentation Request"
+description: Create a new ticket for a documentation request in the PUML repository.
+title: "✏️📘 [PUML Documentation] - <title>"
+labels: [
+  "documentation"
+]
+projects: [
+  "DevOps-MBSE"
+]
+body:
+  - type: checkboxes
+    id: doc-types
+    attributes:
+      label: "Documentation Types"
+      description: Please select the type(s) of documentation your request relates to.
+      options:
+        - label: New
+        - label: Expansion
+        - label: Correction
+  - type: textarea
+    id: documentation
+    attributes:
+      label: "Requested Documentation"
+      placeholder: Describe in a few lines your documentation request.
+    validations:
+      required: true
+  - type: textarea
+    id: reference_issues
+    attributes:
+      label: "Reference Issues"
+      placeholder: "Please include any related #<Issues IDs>"
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -0,0 +1,46 @@
+name: "💭 PUML Feature Request"
+description: Create a new ticket for a new feature request in the PUML repository.
+title: "💭 [PUML REQUEST] - <title>"
+labels: [
+  "question", 
+  "enhancement"
+]
+projects: [
+  "DevOps-MBSE"
+]
+body:
+  - type: textarea
+    id: reference_issues
+    attributes:
+      label: "Reference Issues"
+      placeholder: "#<Issue IDs>"
+    validations:
+      required: false
+  - type: textarea
+    id: summary
+    attributes:
+      label: "Summary"
+      placeholder: Describe in a few lines your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: basic_example
+    attributes:
+      label: "Basic Example"
+      placeholder: A few specific words about your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: drawbacks
+    attributes:
+      label: "What are the drawbacks/impacts of your feature request?"
+      placeholder: Identify the drawbacks and impacts while being neutral on your feature request.
+    validations:
+      required: true
+  - type: textarea
+    id: unresolved_question
+    attributes:
+      label: "Unresolved questions"
+      placeholder: Identify any unresolved issues.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/SIMPLE-TASK.yml

@@ -0,0 +1,41 @@
+name: "📋 PUML Task"
+description: Create a new ticket for a task to go with a PUML feature
+title: "📋 [PUML TASK] - <title>"
+labels: [
+  "enhancement"
+]
+projects: [
+  "DevOps-MBSE"
+]
+body:
+  - type: input
+    id: parent_feature
+    attributes:
+      label: "Parent Feature"
+      placeholder: "#<Issue ID>"
+    validations:
+      required: true
+  - type: textarea
+    id: summary
+    attributes:
+      label: "Task Description"
+      placeholder: Describe in a few lines your task that can be associated with the parent feature.
+    validations:
+      required: true
+  - type: textarea
+    id: ac
+    attributes:
+      label: "Acceptance Criteria"
+      placeholder: |
+        Provide initial criteria to determine when the work is complete and elligible for merging.
+        i.e. - [ ] Include unit tests for new thing
+             - [ ] Update documentation with new thing
+    validations:
+      required: true
+  - type: textarea
+    id: unresolved_question
+    attributes:
+      label: "Unresolved questions"
+      placeholder: Identify any unresolved issues.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+blank_issues_enabled: false
+contact_links:
+  - name: AaC Community Support
+    url: https://github.com/DevOps-MBSE/AaC/discussions
+    about: Please ask and answer questions here.
+
+

.github/pull_request_template.md

@@ -0,0 +1,40 @@
+# Description
+
+Include a summary of the changes and the related issue. List any dependencies that are required for this change.
+
+# Linked Items:
+
+Closes/Fixes/Resolves #XYZ
+
+### Added
+
+- _Describe any new features._
+
+### Changed
+
+- _Describe any changes in existing functionality._
+
+### Deprecated
+
+- _Describe any deprecated features._
+
+### Removed
+
+- _Describe any removed features._
+
+### Fixed
+
+- _Describe any bug fixes._
+
+### Security
+
+- _Describe any security-related changes._
+
+# Checklist:
+
+- [ ] I updated project documentation to reflect my changes.
+- [ ] My changes generate no new warnings.
+- [ ] I updated new and existing unit tests to account for my changes.
+- [ ] I linked the associated item(s) to be closed.
+- [ ] I bumped the version.
+- [ ] I added the labels corresponding to my changes.

.github/release.yml

@@ -0,0 +1,28 @@
+# .github/release.yml
+
+changelog:
+  categories:
+    - title: Added 💭
+      labels:
+        - added
+    - title: Changed 🛠
+      labels:
+        - changed
+    - title: Deprecated 💾
+      labels:
+        - deprecated
+    - title: Removed ✂️
+      labels:
+        - removed
+    - title: Fixed 🐛
+      labels:
+        - fixed
+    - title: Security 🔒
+      labels: 
+        - security
+    - title: Documentation ✏️📘
+      labels:
+        - documentation
+    - title: Other Changes 📈
+      labels:
+        - "*"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '15 1 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2