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

Setup Documentation, GitHub Actions workflows, linting, and styling standards for NM actions #26

Merged
merged 8 commits into from
Sep 18, 2024

Conversation

markurtz
Copy link
Member

Summary:

This pull request sets up the foundational components for the repository, including GitHub Actions workflows for development and main branches, documentation updates, linting, and style standards. The changes introduce a .gitignore file, GitHub workflows (development.yml and main.yml), and configuration files for ruff, mypy, yamlfix, and markdown formatting, ensuring code quality, style consistency, and efficient CI/CD pipelines.

Details:

  • Added GitHub Actions workflows for development and main branches.
  • Configured tox environments to run quality checks and style enforcement.
  • Introduced .gitignore to filter unnecessary files.
  • Configured ruff, mypy, yamlfix, and markdown formatting settings to enforce quality and style standards across the repository.
  • Updated README with instructions on setting up GitHub Actions and contribution guidelines.
  • Added a pull request template for consistency in contributions.
  • Configured automatic formatting and linting for YAML and markdown files using yamlfix and mdformat.

Test Plan:

  • Ensure the following GitHub Actions workflows execute successfully:
    • development.yml on all branches for code quality checks.
    • main.yml on main branch for production-quality validation.
  • Run tox -e quality to confirm that all files meet quality standards.
  • Verify tox -e style applies formatting and styling corrections without errors.

Related Issues:

N/A

andy-neuma
andy-neuma previously approved these changes Sep 18, 2024
Copy link
Member

@andy-neuma andy-neuma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

.github/pull_request_template.md Show resolved Hide resolved
.github/workflows/development.yml Outdated Show resolved Hide resolved
.gitignore Show resolved Hide resolved
derekk-nm
derekk-nm previously approved these changes Sep 18, 2024
Copy link
Contributor

@derekk-nm derekk-nm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for closing the loop on this Andy

.github/workflows/development.yml Outdated Show resolved Hide resolved
.gitignore Show resolved Hide resolved
actions/pypi_build/action.yaml Outdated Show resolved Hide resolved
actions/testmo-run-create/action.yml Show resolved Hide resolved
Copy link
Member

@dhuangnm dhuangnm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@dhuangnm dhuangnm added this pull request to the merge queue Sep 18, 2024
Merged via the queue into main with commit 4515269 Sep 18, 2024
1 check passed
@dhuangnm dhuangnm deleted the standardization branch September 18, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants