From c02f54f5e8394677fdb8ef933a41a343bb9a5728 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 13:55:41 +0200 Subject: [PATCH 01/26] maint: update `labeler.yml` --- .github/labeler.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/labeler.yml b/.github/labeler.yml index 296d0574ae..39e1eafd61 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -13,3 +13,7 @@ Dependencies: CI/CD: - changed-files: - any-glob-to-any-file: ['docker/**/*', '.github/**/*', '.ci/**/*'] + +Testing: +- changed-files: + - any-glob-to-any-file: ['tests/*', 'tests/**/*'] \ No newline at end of file From c87d32888803e0d4e7c0f21edf193bb7d7b09c57 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 14:21:54 +0200 Subject: [PATCH 02/26] feat: implementing `ansys/actions/changelogs` --- .github/workflows/label.yml | 17 +++++++++++- CHANGELOG.md | 7 +++++ doc/changelog.d/changelog_template.jinja | 17 ++++++++++++ doc/source/changelog.rst | 10 +++++++ doc/source/conf.py | 12 +++++++-- doc/source/index.rst | 1 + pyproject.toml | 34 ++++++++++++++++++++++++ 7 files changed, 95 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 doc/changelog.d/changelog_template.jinja create mode 100644 doc/source/changelog.rst diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index e6a541d5c0..0718a221a3 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -1,7 +1,10 @@ name: "Pull Request Labeler" on: pull_request: - types: [opened, reopened] + # opened, reopened, and synchronize are default for pull_request + # edited - when PR title or body is changed + # labeled - when labels are added to PR + types: [opened, reopened, synchronize, edited, labeled] push: branches: [ main ] paths: @@ -101,3 +104,15 @@ jobs: - [Examples](https://github.com/ansys/pymapdl/pulls?q=label%3Aexamples+) - [Maintenance](https://github.com/ansys/pymapdl/pulls?q=label%3Amaintenance+) - [CI/CD](https://github.com/ansys/pymapdl/pulls?q=label%3Aci%2Fcd+) + + changelog-fragment: + name: "Create changelog fragment" + needs: [labeler] + permissions: + contents: write + pull-requests: write + runs-on: ubuntu-latest + steps: + - uses: ansys/actions/doc-changelog@v6 + with: + token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..5637a60c9b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# CHANGELOG + +This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs. + +Refer to the [raw release notes](doc/source/changelog.rst) for more information. + +[Published release notes](https://mapdl.docs.pyansys.com/version/stable/changelog.html) can be found in the online documentation. diff --git a/doc/changelog.d/changelog_template.jinja b/doc/changelog.d/changelog_template.jinja new file mode 100644 index 0000000000..a346bcd9d5 --- /dev/null +++ b/doc/changelog.d/changelog_template.jinja @@ -0,0 +1,17 @@ +{% if sections[""] %} +{% for category, val in definitions.items() if category in sections[""] %} + +{{ definitions[category]['name'] }} +{% set underline = '^' * definitions[category]['name']|length %} +{{ underline }} + +{% for text, values in sections[""][category].items() %} +- {{ text }} {{ values|join(', ') }} +{% endfor %} + +{% endfor %} +{% else %} +No significant changes. + + +{% endif %} \ No newline at end of file diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst new file mode 100644 index 0000000000..41b617a16d --- /dev/null +++ b/doc/source/changelog.rst @@ -0,0 +1,10 @@ +.. _ref_release_notes: + +Release notes +############# + +This document contains the release notes for the project. + +.. vale off + +.. towncrier release notes start \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index a596bce6ff..1c42c3fb57 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -57,6 +57,7 @@ # The short X.Y version release = version = __version__ cname = os.getenv("DOCUMENTATION_CNAME", "mapdl.docs.pyansys.com") +switcher_version = get_version_match(__version__) REPOSITORY_NAME = "pymapdl" USERNAME = "ansys" @@ -224,6 +225,13 @@ "pyvista.Plotter.show", ] +# If we are on a release, we have to ignore the "release" URLs, since it is not +# available until the release is published. +if switcher_version != "dev": + linkcheck_ignore.append( + f"https://github.com/ansys/pymapdl/releases/tag/v{__version__}" + ) + user_agent = """curl https://www.ansys.com -A "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.3""" # The name of the Pygments (syntax highlighting) style to use. @@ -294,12 +302,12 @@ ], "switcher": { "json_url": f"https://{cname}/versions.json", - "version_match": get_version_match(__version__), + "version_match": switcher_version, }, "use_meilisearch": { "api_key": os.getenv("MEILISEARCH_PUBLIC_API_KEY", ""), "index_uids": { - f"pymapdl-v{get_version_match(__version__).replace('.', '-')}": "PyMAPDL", + f"pymapdl-v{switcher_version.replace('.', '-')}": "PyMAPDL", }, }, } diff --git a/doc/source/index.rst b/doc/source/index.rst index e9b46222fd..e84487c86b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,6 +15,7 @@ mapdl_commands/index api/index examples/index + changelog .. image:: ../source/_static/logo_dark.png diff --git a/pyproject.toml b/pyproject.toml index afceaf4e4a..1dd064d601 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -230,3 +230,37 @@ override_SS05 = [ # override SS05 to allow docstrings starting with these words # '^Assess ', # '^Access ', ] + +[tool.towncrier] +package = "ansys.math.core" +directory = "doc/changelog.d" +filename = "doc/source/changelog.rst" +template = "doc/changelog.d/changelog_template.jinja" +start_string = ".. towncrier release notes start\n" +title_format = "`{version} `_ - {project_date}" +issue_format = "`#{issue} `_" + +[[tool.towncrier.type]] +directory = "added" +name = "Added" +showcontent = true + +[[tool.towncrier.type]] +directory = "changed" +name = "Changed" +showcontent = true + +[[tool.towncrier.type]] +directory = "fixed" +name = "Fixed" +showcontent = true + +[[tool.towncrier.type]] +directory = "dependencies" +name = "Dependencies" +showcontent = true + +[[tool.towncrier.type]] +directory = "miscellaneous" +name = "Miscellaneous" +showcontent = true \ No newline at end of file From d332d77b053a73b193d0fa25019fffb80456d00e Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot Date: Mon, 22 Apr 2024 12:25:26 +0000 Subject: [PATCH 03/26] Adding changelog entry: 3019.miscellaneous.md --- doc/changelog.d/3019.miscellaneous.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/3019.miscellaneous.md diff --git a/doc/changelog.d/3019.miscellaneous.md b/doc/changelog.d/3019.miscellaneous.md new file mode 100644 index 0000000000..9eb1cbe4b5 --- /dev/null +++ b/doc/changelog.d/3019.miscellaneous.md @@ -0,0 +1 @@ +feat: implementing `ansys/actions/changelogs` and adding release note in documentation \ No newline at end of file From 70ac8efdbccd2f16eeae895737581a672b5dfe26 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:49:47 +0200 Subject: [PATCH 04/26] maint: adding `doc-deploy-changelog` action and removing `release.yml` as unused --- .github/release.yml | 21 --------------------- .github/workflows/ci.yml | 13 +++++++++++++ 2 files changed, 13 insertions(+), 21 deletions(-) delete mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml deleted file mode 100644 index e485711e4a..0000000000 --- a/.github/release.yml +++ /dev/null @@ -1,21 +0,0 @@ -changelog: - categories: - - title: New Features - labels: - - Enhancement - - NEW FEATURE - - title: Bug fixes or behavior changes - labels: - - BUG - - BLOCKER - - title: Documentation - labels: - - Documentation - - Examples - - title: Maintenance - labels: - - Maintenance - - Dependencies - - title: MAPDL and/or API related - labels: - - MAPDL diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 07ccdf179d..41ad41ff6c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -59,6 +59,19 @@ permissions: jobs: + + update-changelog: + name: "Update CHANGELOG (on release)" + if: github.event_name == 'push' && contains(github.ref, 'refs/tags') + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + steps: + - uses: ansys/actions/doc-deploy-changelog@v6 + with: + token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }} + doc-style: name: "Documentation style check" runs-on: ubuntu-latest From 27b934594932c008e9eab2cc23f85f7f0eb71d9d Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:56:57 +0200 Subject: [PATCH 05/26] maint: adding `update-changelog` as a CICD dependency --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 41ad41ff6c..337dc946a1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -828,7 +828,7 @@ jobs: release: name: "Release" if: github.event_name == 'push' && contains(github.ref, 'refs/tags') - needs: [smoke-tests, docs-build, build-test, build-test-ubuntu, build-test-ubuntu-minimal] + needs: [smoke-tests, docs-build, build-test, build-test-ubuntu, build-test-ubuntu-minimal, update-changelog] runs-on: ubuntu-latest steps: - name: Set up Python From 0cb6e9059c696ab3c92d0c71fe1222ab57de5548 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 23 Apr 2024 10:32:35 +0200 Subject: [PATCH 06/26] fix: `changelog.rst` file --- doc/source/changelog.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst index 41b617a16d..48f1892cd7 100644 --- a/doc/source/changelog.rst +++ b/doc/source/changelog.rst @@ -7,4 +7,7 @@ This document contains the release notes for the project. .. vale off -.. towncrier release notes start \ No newline at end of file +.. towncrier release notes start + + +.. vale on From 21dd02a5b8a21463d8c2c71f39f14b8e3885bd3d Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 23 Apr 2024 18:00:10 +0200 Subject: [PATCH 07/26] revert: readding `release.yml` file --- .github/release.yml | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000000..e485711e4a --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,21 @@ +changelog: + categories: + - title: New Features + labels: + - Enhancement + - NEW FEATURE + - title: Bug fixes or behavior changes + labels: + - BUG + - BLOCKER + - title: Documentation + labels: + - Documentation + - Examples + - title: Maintenance + labels: + - Maintenance + - Dependencies + - title: MAPDL and/or API related + labels: + - MAPDL From f9a03e2f3a84b35f1cb3e0fff3a5021e9b22c67f Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 13:55:41 +0200 Subject: [PATCH 08/26] maint: update `labeler.yml` --- .github/labeler.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/labeler.yml b/.github/labeler.yml index 296d0574ae..39e1eafd61 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -13,3 +13,7 @@ Dependencies: CI/CD: - changed-files: - any-glob-to-any-file: ['docker/**/*', '.github/**/*', '.ci/**/*'] + +Testing: +- changed-files: + - any-glob-to-any-file: ['tests/*', 'tests/**/*'] \ No newline at end of file From 7ac90121f4a40efdc93f03ca0664dedb31b71c3c Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 14:21:54 +0200 Subject: [PATCH 09/26] feat: implementing `ansys/actions/changelogs` --- .github/workflows/label.yml | 17 +++++++++++- CHANGELOG.md | 7 +++++ doc/changelog.d/changelog_template.jinja | 17 ++++++++++++ doc/source/changelog.rst | 10 +++++++ doc/source/conf.py | 12 +++++++-- doc/source/index.rst | 1 + pyproject.toml | 34 ++++++++++++++++++++++++ 7 files changed, 95 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 doc/changelog.d/changelog_template.jinja create mode 100644 doc/source/changelog.rst diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index e6a541d5c0..0718a221a3 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -1,7 +1,10 @@ name: "Pull Request Labeler" on: pull_request: - types: [opened, reopened] + # opened, reopened, and synchronize are default for pull_request + # edited - when PR title or body is changed + # labeled - when labels are added to PR + types: [opened, reopened, synchronize, edited, labeled] push: branches: [ main ] paths: @@ -101,3 +104,15 @@ jobs: - [Examples](https://github.com/ansys/pymapdl/pulls?q=label%3Aexamples+) - [Maintenance](https://github.com/ansys/pymapdl/pulls?q=label%3Amaintenance+) - [CI/CD](https://github.com/ansys/pymapdl/pulls?q=label%3Aci%2Fcd+) + + changelog-fragment: + name: "Create changelog fragment" + needs: [labeler] + permissions: + contents: write + pull-requests: write + runs-on: ubuntu-latest + steps: + - uses: ansys/actions/doc-changelog@v6 + with: + token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..5637a60c9b --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# CHANGELOG + +This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs. + +Refer to the [raw release notes](doc/source/changelog.rst) for more information. + +[Published release notes](https://mapdl.docs.pyansys.com/version/stable/changelog.html) can be found in the online documentation. diff --git a/doc/changelog.d/changelog_template.jinja b/doc/changelog.d/changelog_template.jinja new file mode 100644 index 0000000000..a346bcd9d5 --- /dev/null +++ b/doc/changelog.d/changelog_template.jinja @@ -0,0 +1,17 @@ +{% if sections[""] %} +{% for category, val in definitions.items() if category in sections[""] %} + +{{ definitions[category]['name'] }} +{% set underline = '^' * definitions[category]['name']|length %} +{{ underline }} + +{% for text, values in sections[""][category].items() %} +- {{ text }} {{ values|join(', ') }} +{% endfor %} + +{% endfor %} +{% else %} +No significant changes. + + +{% endif %} \ No newline at end of file diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst new file mode 100644 index 0000000000..41b617a16d --- /dev/null +++ b/doc/source/changelog.rst @@ -0,0 +1,10 @@ +.. _ref_release_notes: + +Release notes +############# + +This document contains the release notes for the project. + +.. vale off + +.. towncrier release notes start \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 9dbc60782d..52393493dd 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -57,6 +57,7 @@ # The short X.Y version release = version = __version__ cname = os.getenv("DOCUMENTATION_CNAME", "mapdl.docs.pyansys.com") +switcher_version = get_version_match(__version__) REPOSITORY_NAME = "pymapdl" USERNAME = "ansys" @@ -223,6 +224,13 @@ "pyvista.Plotter.show", ] +# If we are on a release, we have to ignore the "release" URLs, since it is not +# available until the release is published. +if switcher_version != "dev": + linkcheck_ignore.append( + f"https://github.com/ansys/pymapdl/releases/tag/v{__version__}" + ) + user_agent = """curl https://www.ansys.com -A "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.3""" # The name of the Pygments (syntax highlighting) style to use. @@ -293,12 +301,12 @@ ], "switcher": { "json_url": f"https://{cname}/versions.json", - "version_match": get_version_match(__version__), + "version_match": switcher_version, }, "use_meilisearch": { "api_key": os.getenv("MEILISEARCH_PUBLIC_API_KEY", ""), "index_uids": { - f"pymapdl-v{get_version_match(__version__).replace('.', '-')}": "PyMAPDL", + f"pymapdl-v{switcher_version.replace('.', '-')}": "PyMAPDL", }, }, } diff --git a/doc/source/index.rst b/doc/source/index.rst index e9b46222fd..e84487c86b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,6 +15,7 @@ mapdl_commands/index api/index examples/index + changelog .. image:: ../source/_static/logo_dark.png diff --git a/pyproject.toml b/pyproject.toml index 567b558e2f..7ddea6645a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -230,3 +230,37 @@ override_SS05 = [ # override SS05 to allow docstrings starting with these words # '^Assess ', # '^Access ', ] + +[tool.towncrier] +package = "ansys.math.core" +directory = "doc/changelog.d" +filename = "doc/source/changelog.rst" +template = "doc/changelog.d/changelog_template.jinja" +start_string = ".. towncrier release notes start\n" +title_format = "`{version} `_ - {project_date}" +issue_format = "`#{issue} `_" + +[[tool.towncrier.type]] +directory = "added" +name = "Added" +showcontent = true + +[[tool.towncrier.type]] +directory = "changed" +name = "Changed" +showcontent = true + +[[tool.towncrier.type]] +directory = "fixed" +name = "Fixed" +showcontent = true + +[[tool.towncrier.type]] +directory = "dependencies" +name = "Dependencies" +showcontent = true + +[[tool.towncrier.type]] +directory = "miscellaneous" +name = "Miscellaneous" +showcontent = true \ No newline at end of file From b64071db40e6cf1d166532c8355980573d3a2213 Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot Date: Mon, 22 Apr 2024 12:25:26 +0000 Subject: [PATCH 10/26] Adding changelog entry: 3019.miscellaneous.md --- doc/changelog.d/3019.miscellaneous.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/3019.miscellaneous.md diff --git a/doc/changelog.d/3019.miscellaneous.md b/doc/changelog.d/3019.miscellaneous.md new file mode 100644 index 0000000000..9eb1cbe4b5 --- /dev/null +++ b/doc/changelog.d/3019.miscellaneous.md @@ -0,0 +1 @@ +feat: implementing `ansys/actions/changelogs` and adding release note in documentation \ No newline at end of file From 2dce74438b8612b72f79183cc0881a3769a4a947 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:49:47 +0200 Subject: [PATCH 11/26] maint: adding `doc-deploy-changelog` action and removing `release.yml` as unused --- .github/release.yml | 21 --------------------- .github/workflows/ci.yml | 13 +++++++++++++ 2 files changed, 13 insertions(+), 21 deletions(-) delete mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml deleted file mode 100644 index e485711e4a..0000000000 --- a/.github/release.yml +++ /dev/null @@ -1,21 +0,0 @@ -changelog: - categories: - - title: New Features - labels: - - Enhancement - - NEW FEATURE - - title: Bug fixes or behavior changes - labels: - - BUG - - BLOCKER - - title: Documentation - labels: - - Documentation - - Examples - - title: Maintenance - labels: - - Maintenance - - Dependencies - - title: MAPDL and/or API related - labels: - - MAPDL diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 07ccdf179d..41ad41ff6c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -59,6 +59,19 @@ permissions: jobs: + + update-changelog: + name: "Update CHANGELOG (on release)" + if: github.event_name == 'push' && contains(github.ref, 'refs/tags') + runs-on: ubuntu-latest + permissions: + contents: write + pull-requests: write + steps: + - uses: ansys/actions/doc-deploy-changelog@v6 + with: + token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }} + doc-style: name: "Documentation style check" runs-on: ubuntu-latest From 8f54f3c34f634f4de3f88702a405d70557b5da8f Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:56:57 +0200 Subject: [PATCH 12/26] maint: adding `update-changelog` as a CICD dependency --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 41ad41ff6c..337dc946a1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -828,7 +828,7 @@ jobs: release: name: "Release" if: github.event_name == 'push' && contains(github.ref, 'refs/tags') - needs: [smoke-tests, docs-build, build-test, build-test-ubuntu, build-test-ubuntu-minimal] + needs: [smoke-tests, docs-build, build-test, build-test-ubuntu, build-test-ubuntu-minimal, update-changelog] runs-on: ubuntu-latest steps: - name: Set up Python From 7136238f3662610323549da63bbeb8061483d765 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 23 Apr 2024 10:32:35 +0200 Subject: [PATCH 13/26] fix: `changelog.rst` file --- doc/source/changelog.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst index 41b617a16d..48f1892cd7 100644 --- a/doc/source/changelog.rst +++ b/doc/source/changelog.rst @@ -7,4 +7,7 @@ This document contains the release notes for the project. .. vale off -.. towncrier release notes start \ No newline at end of file +.. towncrier release notes start + + +.. vale on From 67926bb181dd44c1b409f8f39608c773bed506d1 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 23 Apr 2024 18:00:10 +0200 Subject: [PATCH 14/26] revert: readding `release.yml` file --- .github/release.yml | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 0000000000..e485711e4a --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,21 @@ +changelog: + categories: + - title: New Features + labels: + - Enhancement + - NEW FEATURE + - title: Bug fixes or behavior changes + labels: + - BUG + - BLOCKER + - title: Documentation + labels: + - Documentation + - Examples + - title: Maintenance + labels: + - Maintenance + - Dependencies + - title: MAPDL and/or API related + labels: + - MAPDL From bf27aee0f4b0b3e2ec3899313cdee8e26491c15a Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 30 Apr 2024 18:08:02 +0200 Subject: [PATCH 15/26] Update CHANGELOG.md Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5637a60c9b..8c8f3e575a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,6 @@ This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs. -Refer to the [raw release notes](doc/source/changelog.rst) for more information. +For more information, see the [raw release notes](doc/source/changelog.rst). [Published release notes](https://mapdl.docs.pyansys.com/version/stable/changelog.html) can be found in the online documentation. From 4a3b02950e4d4aaa75f6cb5445ceb6979cfa8dba Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 4 Jun 2024 11:26:00 +0200 Subject: [PATCH 16/26] maint: adding `branch-name-style` and `commit-style` --- .github/workflows/ci.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b70f02d747..9893f69ee7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -72,6 +72,28 @@ jobs: with: token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }} + + branch-name: + # Only if the event is a pull request and the branch name is not from the pre-commit-ci bot + if: github.event_name == 'pull_request' && github.head_ref != 'pre-commit-ci-update-config' + name: Check the name of the branch + runs-on: ubuntu-latest + steps: + - name: Check branch name + uses: ansys/actions/branch-name-style@v6 + + + commit-name: + if: github.event_name == 'pull_request' + name: Check the name of the commit + runs-on: ubuntu-latest + steps: + - name: Check commit name + uses: ansys/actions/commit-style@v6 + with: + token: ${{ secrets.GITHUB_TOKEN }} + + doc-style: name: "Documentation style check" runs-on: ubuntu-latest @@ -82,6 +104,7 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} vale-version: "3.4.1" + smoke-tests: name: Build and smoke test (${{ matrix.os }} | Python ${{ matrix.python-version }}) (Release=${{ matrix.should-release }}) runs-on: ${{ matrix.os }} From e4f8ae8183af2aead3c46f510039265638fd3f53 Mon Sep 17 00:00:00 2001 From: German Date: Tue, 11 Jun 2024 11:29:47 +0200 Subject: [PATCH 17/26] Adding pull request template --- .github/pull_request_template.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..07553525be --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +## Description +**Please provide a brief description of the changes made in this pull request.** + +## Issue linked +**Please mention the issue number or describe the problem this pull request addresses.** + +## Checklist +- [ ] I have tested my changes locally. +- [ ] I have added necessary documentation or updated existing documentation. +- [ ] I have followed the coding style guidelines of this project. +- [ ] I have added appropriate unit tests. +- [ ] I have reviewed my changes before submitting this pull request. +- [ ] I have linked the issue or issues that are solved to the PR if any. +- [ ] I have assigned this PR to myself. +- [ ] I have added the minimum version decorator to any new backend method implemented. +- [ ] I have made sure that the title of my PR follows [Commit naming conventions](https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions) (e.g. ``feat: adding new MAPDL command``) \ No newline at end of file From 545cd602a94eb569064281a5c10294d15ead9e0e Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 11 Jun 2024 17:27:10 +0200 Subject: [PATCH 18/26] Update pyproject.toml Co-authored-by: German <28149841+germa89@users.noreply.github.com> --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 00e21f0a56..0b3f8e5789 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -229,7 +229,7 @@ override_SS05 = [ # override SS05 to allow docstrings starting with these words ] [tool.towncrier] -package = "ansys.math.core" +package = "ansys.mapdl.core" directory = "doc/changelog.d" filename = "doc/source/changelog.rst" template = "doc/changelog.d/changelog_template.jinja" From 65400b21ee1e2a55897629771d56da85fab79410 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Thu, 13 Jun 2024 18:04:37 +0200 Subject: [PATCH 19/26] doc: adding branch and commit naming convention references --- doc/source/getting_started/contribution.rst | 7 ++++++- doc/source/links.rst | 2 ++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/doc/source/getting_started/contribution.rst b/doc/source/getting_started/contribution.rst index 4ed5b5b194..1efe4805c2 100644 --- a/doc/source/getting_started/contribution.rst +++ b/doc/source/getting_started/contribution.rst @@ -25,7 +25,12 @@ Overall guidance on contributing to a PyAnsys library appears in the in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar with it and the `Coding style `_ before attempting to contribute to PyMAPDL. - + +In order to have a nice :ref:`ref_release_notes` section, it is important to follow +the branch and commit names conventions as described in the +`branch `_ and `commit `_ naming +sections. + Answer discussions ================== diff --git a/doc/source/links.rst b/doc/source/links.rst index d0b79fd47a..a08e6575d5 100644 --- a/doc/source/links.rst +++ b/doc/source/links.rst @@ -23,6 +23,8 @@ .. _dev_guide_contributing: https://dev.docs.pyansys.com/how-to/contributing.html .. _dev_guide_coding_style: https://dev.docs.pyansys.com/coding-style/index.html .. _dev_guide_setup_your_environment: https://dev.docs.pyansys.com/how-to/setting-up.html +.. _dev_guide_branch_names: https://dev.docs.pyansys.com/how-to/contributing.html#branch-naming-conventions +.. _dev_guide_commit_names: https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions .. #Other libraries .. _pyvista_docs: https://docs.pyvista.org/version/stable/ From 57b9ae7d4dd6d1f19eaedfaa4b5c094ed17147cd Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Thu, 13 Jun 2024 18:14:55 +0200 Subject: [PATCH 20/26] doc: adding the mention of the *PyAnsys Developer's Guide* before redirecting to the links --- doc/source/getting_started/contribution.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/getting_started/contribution.rst b/doc/source/getting_started/contribution.rst index 1efe4805c2..10a6fa5ce4 100644 --- a/doc/source/getting_started/contribution.rst +++ b/doc/source/getting_started/contribution.rst @@ -27,7 +27,7 @@ with it and the `Coding style `_ before attempting to contribute to PyMAPDL. In order to have a nice :ref:`ref_release_notes` section, it is important to follow -the branch and commit names conventions as described in the +the branch and commit names conventions as described in the *PyAnsys Developer's Guide* `branch `_ and `commit `_ naming sections. From 423537a2f80a0f915b2ccfe2abd26af57a7f46f5 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 17 Jun 2024 16:12:39 +0200 Subject: [PATCH 21/26] Apply suggestions from code review Co-authored-by: German <28149841+germa89@users.noreply.github.com> --- .github/pull_request_template.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 07553525be..1e10f21e2c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,10 +5,11 @@ **Please mention the issue number or describe the problem this pull request addresses.** ## Checklist -- [ ] I have tested my changes locally. -- [ ] I have added necessary documentation or updated existing documentation. -- [ ] I have followed the coding style guidelines of this project. -- [ ] I have added appropriate unit tests. +- [ ] I have visited and read [Develop PyMAPDL](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#develop-pymapdl). +- [ ] I have [tested my changes locally](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#unit-testing) +- [ ] I have added necessary [documentation or updated existing documentation](https://mapdl.docs.pyansys.com/version/stable/getting_started/write_documentation.html#id2). +- [ ] I have followed the [PyMAPDL coding style guidelines](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#code-style). +- [ ] I have added appropriate [unit tests](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#unit-testing) that also ensure the [minimal coverage criteria](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#code-coverage). - [ ] I have reviewed my changes before submitting this pull request. - [ ] I have linked the issue or issues that are solved to the PR if any. - [ ] I have assigned this PR to myself. From d368f4144c5a004bbb2c76760be0b90abcba1999 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 17 Jun 2024 16:17:18 +0200 Subject: [PATCH 22/26] doc: removing unused practice --- .github/pull_request_template.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1e10f21e2c..cb84f12f4a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,5 +13,4 @@ - [ ] I have reviewed my changes before submitting this pull request. - [ ] I have linked the issue or issues that are solved to the PR if any. - [ ] I have assigned this PR to myself. -- [ ] I have added the minimum version decorator to any new backend method implemented. - [ ] I have made sure that the title of my PR follows [Commit naming conventions](https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions) (e.g. ``feat: adding new MAPDL command``) \ No newline at end of file From 9e15eddc91c457f7f5dd670be0e7fcfc559654ce Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 17 Jun 2024 16:51:16 +0200 Subject: [PATCH 23/26] maint: removing `Testing` label in `labeler.yml` --- .github/labeler.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/labeler.yml b/.github/labeler.yml index 39e1eafd61..296d0574ae 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -13,7 +13,3 @@ Dependencies: CI/CD: - changed-files: - any-glob-to-any-file: ['docker/**/*', '.github/**/*', '.ci/**/*'] - -Testing: -- changed-files: - - any-glob-to-any-file: ['tests/*', 'tests/**/*'] \ No newline at end of file From 365563996bf10116ff3d0c2714fe364c39ac4b84 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Mon, 17 Jun 2024 17:28:16 +0200 Subject: [PATCH 24/26] doc: redirecting to PyAnsys dev guide --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index cb84f12f4a..3b34dbb01b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,6 +11,6 @@ - [ ] I have followed the [PyMAPDL coding style guidelines](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#code-style). - [ ] I have added appropriate [unit tests](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#unit-testing) that also ensure the [minimal coverage criteria](https://mapdl.docs.pyansys.com/version/stable/getting_started/develop_pymapdl.html#code-coverage). - [ ] I have reviewed my changes before submitting this pull request. -- [ ] I have linked the issue or issues that are solved to the PR if any. -- [ ] I have assigned this PR to myself. +- [ ] I have [linked the issue or issues](https://dev.docs.pyansys.com/content-writing/content-how-tos/create-PR.html#id2) that are solved to the PR if any. +- [ ] I have [assigned this PR to myself](https://dev.docs.pyansys.com/content-writing/content-how-tos/create-PR.html#id2). - [ ] I have made sure that the title of my PR follows [Commit naming conventions](https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions) (e.g. ``feat: adding new MAPDL command``) \ No newline at end of file From de9a10d1aff04d67eec67facb88d98814ba952e6 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 18 Jun 2024 09:43:20 +0200 Subject: [PATCH 25/26] Update .github/pull_request_template.md Co-authored-by: German <28149841+germa89@users.noreply.github.com> --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3b34dbb01b..87b17bd087 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,4 +13,5 @@ - [ ] I have reviewed my changes before submitting this pull request. - [ ] I have [linked the issue or issues](https://dev.docs.pyansys.com/content-writing/content-how-tos/create-PR.html#id2) that are solved to the PR if any. - [ ] I have [assigned this PR to myself](https://dev.docs.pyansys.com/content-writing/content-how-tos/create-PR.html#id2). +- [ ] I have marked this PR as ``draft`` if it is not ready to be reviewed yet. - [ ] I have made sure that the title of my PR follows [Commit naming conventions](https://dev.docs.pyansys.com/how-to/contributing.html#commit-naming-conventions) (e.g. ``feat: adding new MAPDL command``) \ No newline at end of file From 0e27a4fefd9939780bf86c089febf5520b0f7ec6 Mon Sep 17 00:00:00 2001 From: Camille <78221213+clatapie@users.noreply.github.com> Date: Tue, 18 Jun 2024 09:51:12 +0200 Subject: [PATCH 26/26] fix: updating `dependabot.yml` file --- .github/dependabot.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 51343962e9..7f6e7eb7ce 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -10,7 +10,7 @@ updates: assignees: - "ansys/pymapdl-maintainers" commit-message: - prefix: "MAINT" + prefix: "ci" groups: actions: patterns: @@ -29,7 +29,7 @@ updates: assignees: - "ansys/pymapdl-maintainers" commit-message: - prefix: "MAINT" + prefix: "build" groups: minimal: patterns: