Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aac-puml project infrastructure setup (#774) #1

Merged
merged 76 commits into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
76 commits
Select commit Hold shift + click to select a range
648e1e5
Update README.md
crazynewidea Mar 5, 2024
6eddffb
project workflow changes
crazynewidea Mar 5, 2024
5c3839e
README changes
crazynewidea Mar 5, 2024
a658415
disabling codeql-analysis workflow due to advanced security inavailab…
crazynewidea Mar 5, 2024
27807da
filename spelling fix
crazynewidea Mar 5, 2024
d2aa91b
rearranging directory structure to more closely match main AaC project
crazynewidea Mar 5, 2024
b45b4d5
more project infrastructure work
crazynewidea Mar 5, 2024
c2f1a1a
debugging working directory issue
crazynewidea Mar 5, 2024
e42de94
debugging dependency version conflict
crazynewidea Mar 6, 2024
f622c24
adding Dockerfile
crazynewidea Mar 6, 2024
b3c65d2
adding .gitpod.yml
crazynewidea Mar 6, 2024
3343097
fix to dockerfile config
crazynewidea Mar 6, 2024
091bb1b
more project infrastructure work
crazynewidea Mar 7, 2024
dc33e16
tweak to gitpod.yml
crazynewidea Mar 7, 2024
a712cf6
Merge branch local dev changes with gitpod dev changes
crazynewidea Mar 7, 2024
6a543c2
adding .python-version file
crazynewidea Mar 7, 2024
ee9e0f1
adding sphinx config file
crazynewidea Mar 7, 2024
b4dd041
fix to python-build-and-lint workflow
crazynewidea Mar 7, 2024
4a16a21
added tox.ini configuration for tests
crazynewidea Mar 7, 2024
f01987d
Merge branch 'dev' of github.com:DevOps-MBSE/aac-puml into dev
crazynewidea Mar 7, 2024
344ac22
debugging workflows
crazynewidea Mar 8, 2024
1e60357
trigger to test python-build-and-lint.yml
crazynewidea Mar 8, 2024
d55439f
fix to paths for commands with uses: vs run:
crazynewidea Mar 8, 2024
d04c65c
fix to artifact upload path
crazynewidea Mar 8, 2024
b28f559
fix to pip install path
crazynewidea Mar 8, 2024
673afe9
added pipdeptree to Dockerfile
crazynewidea Mar 8, 2024
193df70
.github/
crazynewidea Mar 8, 2024
a8abd90
temporarily disabling pipdeptree
crazynewidea Mar 8, 2024
f03b668
debugging build
crazynewidea Mar 8, 2024
b53d270
Update .gitpod.Dockerfile
crazynewidea Mar 8, 2024
98d76aa
added requirements.txt file
crazynewidea Mar 8, 2024
5d476ba
added myst_parser to requirements.txt
crazynewidea Mar 8, 2024
aa806bc
tweaking sphinx requirement
crazynewidea Mar 8, 2024
7f1e39d
requirements tweak
crazynewidea Mar 8, 2024
4e2003d
added sphinx-contributors requirement
crazynewidea Mar 8, 2024
6811574
added sphinx_copybutton requirement
crazynewidea Mar 8, 2024
dba6626
added furo theme to sphinx
crazynewidea Mar 8, 2024
403a429
added nose2 to requirements
crazynewidea Mar 8, 2024
ae5b449
updated checkout action version for Node 20 compatibility
crazynewidea Mar 8, 2024
56c4647
reenabled unit tests
crazynewidea Mar 8, 2024
bd3495d
fixed yaml issue in dev branch workflow
crazynewidea Mar 8, 2024
f5ddc73
updated setup-python action version
crazynewidea Mar 8, 2024
7ae6e9c
switching to work on cross platform build & test
crazynewidea Mar 8, 2024
62bb9e5
adding secure_install
crazynewidea Mar 8, 2024
e8332e4
Merge branch 'dev' of github.com:DevOps-MBSE/aac-puml into dev
crazynewidea Mar 8, 2024
855207a
changes to relax python version requirement
crazynewidea Mar 8, 2024
72052fe
hunting for python version to satisfy all workflow dependencies
crazynewidea Mar 8, 2024
fe0ec2f
updated Dockerfile python version. set execution permission for pipel…
crazynewidea Mar 8, 2024
1df72fb
adding hashes to requirements.txt
crazynewidea Mar 8, 2024
883e9c8
reenabling unit tests
crazynewidea Mar 11, 2024
2a79ba5
removed version specification of aac from .toml file
crazynewidea Mar 11, 2024
659fbf7
adding a few notes in the README.md
crazynewidea Mar 11, 2024
d440a67
renaming of README file
crazynewidea Mar 11, 2024
d396c54
Update .github/ISSUE_TEMPLATE/BUG-REPORT.yml
crazynewidea Mar 12, 2024
f03f6ff
Update .github/ISSUE_TEMPLATE/DOCUMENTATION-REQUEST.yml
crazynewidea Mar 12, 2024
885da16
Update .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
crazynewidea Mar 12, 2024
7e36965
Update python/tox.ini
crazynewidea Mar 12, 2024
558125b
responding to PR review
crazynewidea Mar 12, 2024
2375ac1
added .pylintrc
crazynewidea Mar 12, 2024
01f2e70
responding to PR review
crazynewidea Mar 12, 2024
e7fd8d2
responding to PR review
crazynewidea Mar 12, 2024
c2b84f8
updated requirements.txt
crazynewidea Mar 12, 2024
433446a
added additional .gitignore in docs folder per PR review request
crazynewidea Mar 12, 2024
cf7c822
responding to PR reviews
crazynewidea Mar 13, 2024
e8a666c
responding to PR review
crazynewidea Mar 13, 2024
21c0d02
Update .gitpod.yml to disable dockerfile
crazynewidea Mar 13, 2024
a397cb2
updated gitpod task for python version
crazynewidea Mar 13, 2024
c9ac2ba
tweak to gitpod.yml
crazynewidea Mar 13, 2024
e1f2759
debugging workspace issue
crazynewidea Mar 13, 2024
429749c
responding to PR review
crazynewidea Mar 13, 2024
543bf36
responding to PR review
crazynewidea Mar 13, 2024
79633fb
actions/checkout version regressed to v3 as requested by PR review
crazynewidea Mar 13, 2024
33833cd
actions/setup-python regressed to v4 as regressed by PR review
crazynewidea Mar 13, 2024
ac26d69
updated .gitignore
crazynewidea Mar 13, 2024
01ba2b0
removed extra dependency entry
crazynewidea Mar 13, 2024
cbf00d1
regress upload-artifacts action to v3 per PR request
crazynewidea Mar 13, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -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

88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -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
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -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
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/SIMPLE-TASK.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: AaC Community Support
url: https://github.com/DevOps-MBSE/AaC/discussions
lizzcondrey marked this conversation as resolved.
Show resolved Hide resolved
about: Please ask and answer questions here.


40 changes: 40 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -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:
- "*"
70 changes: 70 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -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
Loading
Loading