diff --git a/.github/workflows/ci-release.yml b/.github/workflows/ci-release.yml index ba24457..9bb83b1 100644 --- a/.github/workflows/ci-release.yml +++ b/.github/workflows/ci-release.yml @@ -10,13 +10,12 @@ jobs: uses: ./.github/workflows/reusable-static-analysis.yml tests: - needs: static-analysis if: github.repository != 'mattdeform/MayaPythonProjectTemplate' uses: ./.github/workflows/reusable-maya-tests.yml do_release: if: github.repository != 'mattdeform/MayaPythonProjectTemplate' - needs: [static-analysis, tests] + needs: [tests] uses: ./.github/workflows/reusable-semantic-release.yml permissions: contents: write @@ -24,7 +23,7 @@ jobs: docs: if: github.repository != 'mattdeform/MayaPythonProjectTemplate' - needs: [static-analysis, tests, do_release] # only build docs when release is successful + needs: [tests, do_release] # only build docs when release is successful uses: ./.github/workflows/reusable-build-and-deploy-docs.yml permissions: contents: write diff --git a/.github/workflows/reusable-static-analysis.yml b/.github/workflows/reusable-static-analysis.yml index 2b0c6b5..dd39c58 100644 --- a/.github/workflows/reusable-static-analysis.yml +++ b/.github/workflows/reusable-static-analysis.yml @@ -26,7 +26,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install pylint black mypy + pip install pylint mypy - name: Analysing the code with pylint run: | @@ -36,7 +36,7 @@ jobs: uses: psf/black@stable with: src: "src" - options: "--check" + options: "--diff" - name: Analysing the code with mypy run: mypy src \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a4e9a56..ebc5f7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,12 +51,12 @@ This project (optionally) uses [Python Semantic Release](https://python-semantic Cheat sheet: -- Patch release, backwards-compatible bug `fix` _in git commit message title_, e.g. - - `git commit -m 'fix: a great fix'` +- Patch release, backwards-compatible bug `fix` _in git commit message title_. + - `git commit -a -m "fix: a great fix"` - Minor release, backwards-compatible `feat` _in git commit message title_. - - `git commit -m 'feat: Add some AmazingFeature'` -- Major release, incompatible API change `BREAKING CHANGE` _in git commit msg footer (use `fix` or `feat` for message title)_. - - `git commit -m 'feat: Add some AmazingFeature\n\nBREAKING CHANGE'` + - `git commit -a -m "feat: a wonderful new feature"` +- Major release, incompatible API change `BREAKING CHANGE` _in git commit message footer (use `fix` or `feat` for message title)_. + - `git commit -a -m "feat: total refactor" -m "BREAKING CHANGE: breaks api"`

(back to top)

diff --git a/README.md b/README.md index 958a91d..dfdbaba 100644 --- a/README.md +++ b/README.md @@ -16,15 +16,14 @@

Maya Python Project Template

- A GitHub template for Maya Python tools. -
+ A GitHub template for Maya Python tools by TechArtOps.
Report Bug ยท Request Feature

- +> Example project built using this template can be found [here](https://github.com/mattdeform/locator_creator). ## HOW TO USE THIS TEMPLATE @@ -39,20 +38,20 @@ ## What is included in this template? * Basic project structure. -* [README.md](_README.md) template. -* [CONTRIBUTING.md](CONTRIBUTING.md) template. +* [README.md](_README) and [CONTRIBUTING](CONTRIBUTING.md) templates. * Bug report and feature request templates. * Continuous integration using [GitHub Actions][github-actions-url] with jobs to: - * [Run tests](.github/workflows/reusable-maya-tests.yml) in containerized Maya. `Note: User should hold a valid Maya license.` + * [Run integration tests](.github/workflows/reusable-maya-tests.yml) across a range of Maya versions in isolated Docker containers. + * `Note: You should hold a valid Maya license.` * [Enforce coding standards](.github/workflows/reusable-static-analysis.yml) with [pylint](https://pypi.org/project/pylint/), [black](https://github.com/psf/black), and [mypy](https://mypy.readthedocs.io/en/stable/). * [Build and deploy documentation](.github/workflows/reusable-build-and-deploy-docs.yml) to GitHub pages with [mkdocs](https://www.mkdocs.org/). - * [Make versioned releases](.github/workflows/ci-release.yml) using python semantic versioning. + * [Automated releases](.github/workflows/ci-release.yml) using Python Semantic Versioning (optional). ## Acknowledgments * This project uses Docker images courtesy of [mottosso/docker-maya](https://github.com/mottosso/docker-maya). -* Inspiration taken from both +* Inspiration taken from both: * [python-project-template](https://github.com/rochacbruno/python-project-template/tree/main). * [Best-README-Template](https://github.com/othneildrew/Best-README-Template). diff --git a/_README.md b/_README.md index fab5f0f..a6b7c12 100644 --- a/_README.md +++ b/_README.md @@ -154,9 +154,9 @@ Please reach out via the [request a feature](https://github.com/{{PROJECT_OWNER} ## Acknowledgments +* Project template by [TechArtOps](https://www.techartops.com). * foo * bar -* baz

(back to top)

diff --git a/docs/resources/images/ci_release.png b/docs/resources/images/ci_release.png index a4ffad7..66a1413 100644 Binary files a/docs/resources/images/ci_release.png and b/docs/resources/images/ci_release.png differ