release: 1.0.1

Automatically generated by python-semantic-release
sandialabs · Oct 12, 2024 · 8c05e94 · 8c05e94
1 parent 323c99b
commit 8c05e94
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 213 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -33,7 +33,19 @@ repos:
       hooks:
         - id: conventional-pre-commit
           stages: [commit-msg]
-          args: []
+          args: [
+              "build", # Changes to build system or external dependencies (omit from CHANGELOG - manually add if needed)
+              "ci",    # Changes to CI configuration files and scripts (omit from CHANGELOG - manually add if needed)
+              "chore", # Other changes that don't touch the source code (omit from CHANGELOG - manually add if needed)
+              "test", # Adding missing tests or correcting existing tests (does not change package code)
+              "fix",      # A bug fix (a patch-level version change)
+              "perf",     # A code change that improves performance (at-least patch-level, possibly minor version change)
+              "feat",     # A new feature or functionality (at-least minor, possibly major version change)
+              "refactor", # A change that does not add a feature nor fix a bug (could be major, minor or patch)
+              "docs",     # Documentation-only changes within the source code (no version level change)
+              "style",    # A code that does not change meaning of the code (no version level change)
+              "release",
+          ]
 
     - repo: https://github.com/kynan/nbstripout
       rev: 0.7.1

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,180 +1,60 @@
 # CHANGELOG
 
-## v1.0.0 (2024-10-01)
-
-### Unknown
+## v1.0.1 (2024-10-12)
 
-* Harden runner updates ([`f42c300`](https://github.com/sandialabs/sansmic/commit/f42c30023ea0d616dc7849b42b8920051a939158))
+### Fix
 
-* Bump github/codeql-action from 3.26.9 to 3.26.10 (#35)
+* fix: change workflows for proper execution ([`c4ea2f4`](https://github.com/sandialabs/sansmic/commit/c4ea2f4464cbcbdf8d16a94e392fca404348e48e))
 
-Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.26.9 to 3.26.10.
-- [Release notes](https://github.com/github/codeql-action/releases)
-- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
-- [Commits](https://github.com/github/codeql-action/compare/461ef6c76dfe95d5c364de2f431ddbd31a417628...e2b3eafc8d227b0241d48be5f425d47c2d750a13)
+* fix: correct errors in example files (#42)
 
----
-updated-dependencies:
-- dependency-name: github/codeql-action
-  dependency-type: direct:production
-  update-type: version-update:semver-patch
-...
+* build: update and test example jupyter/ipython notebooks
 
-Signed-off-by: dependabot[bot] &lt;[email protected]&gt;
-Co-authored-by: dependabot[bot] &lt;49699333+dependabot[bot]@users.noreply.github.com&gt; ([`432b4cc`](https://github.com/sandialabs/sansmic/commit/432b4cc3c3b052080b12525c26316b6aaf7ab20f))
+Resolves: Missing class call in example files #41
 
-* Patch reset cavern sg on new stage start (#25)
+The ipython notebooks were not being tested. This led to an error in the example notebooks which are now fixed. The testing of any ipynb notebooks checked into the repo has also been added.
 
-* Bring set-cavern-sg back to old behavior
 
----------
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`fdb71c2`](https://github.com/sandialabs/sansmic/commit/fdb71c25c1d4534edf858707803e7caf951999d5))
+### Refactor
 
-* Bump github/codeql-action from 3.26.8 to 3.26.9 (#34)
+* refactor: Convert command-line interface to click instead of argparse (#54)
 
-Bumps [github/codeql-action](https://github.com/github/codeql-action) from 3.26.8 to 3.26.9.
-- [Release notes](https://github.com/github/codeql-action/releases)
-- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
-- [Commits](https://github.com/github/codeql-action/compare/294a9d92911152fe08befb9ec03e240add280cb3...461ef6c76dfe95d5c364de2f431ddbd31a417628)
+* docs: adding logo images ([`eb66068`](https://github.com/sandialabs/sansmic/commit/eb6606804a19a3324ebedf77ed7638151a477611))
 
----
-updated-dependencies:
-- dependency-name: github/codeql-action
-  dependency-type: direct:production
-  update-type: version-update:semver-patch
-...
-
-Signed-off-by: dependabot[bot] &lt;[email protected]&gt;
-Co-authored-by: dependabot[bot] &lt;49699333+dependabot[bot]@users.noreply.github.com&gt; ([`a7dbc83`](https://github.com/sandialabs/sansmic/commit/a7dbc83d41bddfbfeb923337ce9cab5acf49a319))
-
-* Bump pypa/gh-action-pypi-publish from 1.10.1 to 1.10.2 (#33) ([`1e204f3`](https://github.com/sandialabs/sansmic/commit/1e204f35e359c4aa63f5e237fbe0abc84711c69a))
-
-* Bump pypa/cibuildwheel from 2.11.1 to 2.21.1 (#31) ([`62ab2b5`](https://github.com/sandialabs/sansmic/commit/62ab2b52750d48d904eaced19cef3e85e5ea9e9a))
-
-* Bump github/codeql-action from 3.26.7 to 3.26.8 (#32) ([`2c74ba1`](https://github.com/sandialabs/sansmic/commit/2c74ba1231153f5525723d7174f3d788ce85f509))
-
-* Update .pre-commit-config.yaml
+* build: add nbstripout to pre-commit actions to clean notebooks files
 
-Pylint and cpplint need way more configuration before being added to pre-commit
+* Fix pypi upload ([`abd9b67`](https://github.com/sandialabs/sansmic/commit/abd9b6784ee3150ff11a3964ed73ae330c4fbf08))
 
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`2a98371`](https://github.com/sandialabs/sansmic/commit/2a9837129e1fe70bec4a626086398db160ceaa05))
-
-* Bump step-security/harden-runner from 2.8.1 to 2.10.1 (#28)
-
-Bumps [step-security/harden-runner](https://github.com/step-security/harden-runner) from 2.8.1 to 2.10.1.
-- [Release notes](https://github.com/step-security/harden-runner/releases)
-- [Commits](https://github.com/step-security/harden-runner/compare/v2.8.1...91182cccc01eb5e619899d80e4e971d6181294a7)
-
----
-updated-dependencies:
-- dependency-name: step-security/harden-runner
-  dependency-type: direct:production
-  update-type: version-update:semver-minor
-...
-
-Signed-off-by: dependabot[bot] &lt;[email protected]&gt;
-Co-authored-by: dependabot[bot] &lt;49699333+dependabot[bot]@users.noreply.github.com&gt; ([`2b2d8f2`](https://github.com/sandialabs/sansmic/commit/2b2d8f25522b50605e9805e44cb8827db6cdf3fc))
-
-* Bump ossf/scorecard-action from 2.3.1 to 2.4.0 (#29)
-
-Bumps [ossf/scorecard-action](https://github.com/ossf/scorecard-action) from 2.3.1 to 2.4.0.
-- [Release notes](https://github.com/ossf/scorecard-action/releases)
-- [Changelog](https://github.com/ossf/scorecard-action/blob/main/RELEASE.md)
-- [Commits](https://github.com/ossf/scorecard-action/compare/0864cf19026789058feabb7e87baa5f140aac736...62b2cac7ed8198b15735ed49ab1e5cf35480ba46)
-
----
-updated-dependencies:
-- dependency-name: ossf/scorecard-action
-  dependency-type: direct:production
-  update-type: version-update:semver-minor
-...
-
-Signed-off-by: dependabot[bot] &lt;[email protected]&gt;
-Co-authored-by: dependabot[bot] &lt;49699333+dependabot[bot]@users.noreply.github.com&gt; ([`2ce2930`](https://github.com/sandialabs/sansmic/commit/2ce2930cd670c954be2fc53425995505b13d6f86))
-
-* Bump codecov/codecov-action from 3.1.6 to 4.5.0 (#30)
+## v1.0.0 (2024-10-01)
 
-Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3.1.6 to 4.5.0.
-- [Release notes](https://github.com/codecov/codecov-action/releases)
-- [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
-- [Commits](https://github.com/codecov/codecov-action/compare/ab904c41d6ece82784817410c45d8b8c02684457...e28ff129e5465c2c0dcc6f003fc735cb6ae0c673)
+* 1.0.0
 
----
-updated-dependencies:
-- dependency-name: codecov/codecov-action
-  dependency-type: direct:production
-  update-type: version-update:semver-major
-...
+Automatically generated by python-semantic-release ([`b02f15e`](https://github.com/sandialabs/sansmic/commit/b02f15ec018ca9aeeca6c25748f544862f65ac1e))
 
-Signed-off-by: dependabot[bot] &lt;[email protected]&gt;
-Co-authored-by: dependabot[bot] &lt;49699333+dependabot[bot]@users.noreply.github.com&gt; ([`b2236bf`](https://github.com/sandialabs/sansmic/commit/b2236bfbbda6a2db7bc42611758c2cb5ebd3796d))
+* Patch reset cavern sg on new stage start (#25)
+* Bring set-cavern-sg back to old behavior
 
-* [StepSecurity] Apply security best practices (#26)
+---------
 
-Signed-off-by: StepSecurity Bot &lt;[email protected]&gt; ([`a7c0e2c`](https://github.com/sandialabs/sansmic/commit/a7c0e2cbd92e1cdba247ee4e8fc52d7edd3c19aa))
+Signed-off-by: David Hart &lt;[email protected]&gt; ([`fdb71c2`](https://github.com/sandialabs/sansmic/commit/fdb71c25c1d4534edf858707803e7caf951999d5))
 
+* Update .pre-commit-config.yaml
 * Update release.yml
-
-Update so that the PyPI installations only occur on a new tagged release.
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`ca2f5a1`](https://github.com/sandialabs/sansmic/commit/ca2f5a1c132a44df747a36f7a20602cbd761c20f))
-
 * Update gh-pages.yml
-
-Publish GHPages action had a condition that would always evaluate as false. This commit fixes that.
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`28614d0`](https://github.com/sandialabs/sansmic/commit/28614d07aa5532fb208c696a970d2b0481ca9251))
-
 * Continuous integration updates (#24)
-
-* Update release.yml
-
-* Add Documentation URL to pyproject.
-
-* Trying the CI build and release
-
----------
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`5031b1f`](https://github.com/sandialabs/sansmic/commit/5031b1f7d71e4f00fe7c52dd38f7bf49867bd99a))
-
-* Update release.yml ([`c27a0fe`](https://github.com/sandialabs/sansmic/commit/c27a0fef643942e2ff1986d2536c875df5f873db))
-
 * Update README.md
-
-Adding link to documentation.
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`df46a5d`](https://github.com/sandialabs/sansmic/commit/df46a5d4feaaf97b4decc115dabe8b89fdc3b3e6))
-
-* Fixing workflows
-
-Adding license and copyrights ([`964ecd4`](https://github.com/sandialabs/sansmic/commit/964ecd4b94a054af6a890de6ede7750fe8c4567e))
-
 * GitHub pages (#23)
-
 * Create and upload sphinx docs.
 * Still needs to fix version switcher.
 
 ---------
 
 Signed-off-by: David Hart &lt;[email protected]&gt; ([`d1905da`](https://github.com/sandialabs/sansmic/commit/d1905da3c15a239897dbda050ce6528d9bcd56a5))
 
-* Update release.yml
-
-Typo that was not caught by github-actions validation, python 3.12 didn&#39;t build. This commit does not change any of the source code.
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`ede0514`](https://github.com/sandialabs/sansmic/commit/ede0514508ae1d3103bc562114689891f69b86a4))
-
 ## v1.0.0-rc.1 (2024-09-14)
 
-### Unknown
-
 * Adding release action ([`ccad071`](https://github.com/sandialabs/sansmic/commit/ccad0714e34b01c43fceec414ebd9c4f8f9dd5f4))
-
 * Update CI workflow to use all OSes and flag coverage by OS ([`3be7f74`](https://github.com/sandialabs/sansmic/commit/3be7f7430544aa13a5d9b5e0c7e56bb1a06130a4))
-
-* Bump version number ([`a358665`](https://github.com/sandialabs/sansmic/commit/a358665adbaa030240ea30b4bd848e498c23bc6d))
-
 * Pull in updates from development branch (#10)
 
 Final initial import for release candidate 1 for v1.0.0. Includes libsansmic and sansmic modules. Includes tests and code coverage configuration. Includes sphinx documentation for UM and API docs, though github pages still needs to be configured.
@@ -184,79 +64,12 @@ Final initial import for release candidate 1 for v1.0.0. Includes libsansmic and
 Signed-off-by: David Hart &lt;[email protected]&gt; ([`8dc4f33`](https://github.com/sandialabs/sansmic/commit/8dc4f33a21ea038a70b1e5ca04c2c682a53e590f))
 
 * Create codecov.yml
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`cdaf4dc`](https://github.com/sandialabs/sansmic/commit/cdaf4dc80a136f3c251a7493fd2cde1e2172a5c5))
-
 * Create dependabot.yml
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`0ed0a33`](https://github.com/sandialabs/sansmic/commit/0ed0a331743e08a0e77c5a00ecba328ef8297d2c))
-
 * Update README.md
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`e0d6360`](https://github.com/sandialabs/sansmic/commit/e0d6360a9ddc6463732a068c54157119d0487064))
-
 * Update LICENSE
-
-Trying to figure out why GitHub and OpenCSS don&#39;t recognize the license
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`f602fc2`](https://github.com/sandialabs/sansmic/commit/f602fc2aa0097b66c3df7aba6e6ff65f415b03f3))
-
-* Pull in smoke tests for build_ext (#8)
-
 * Update to main (#7)
-
-* Remove testing output files
-
 * Fix license text formatting for github to recognize it
-
-* Adding smoke test CXX file, header, and pybind files ([`5789690`](https://github.com/sandialabs/sansmic/commit/57896907544acca6ccabc5d8ef50fc995e4761ca))
-
-* Fix license text formatting for github to recognize it ([`59d6e32`](https://github.com/sandialabs/sansmic/commit/59d6e32224fca56364a3178614f8d3ebe17db0f7))
-
-* Remove testing output files ([`9cffcf1`](https://github.com/sandialabs/sansmic/commit/9cffcf1f80be875f8a3e2b2bbc064598f71907a5))
-
 * First pre-commit hooks update ([`743cace`](https://github.com/sandialabs/sansmic/commit/743cace17bb4c4e1e6b5ac2c5d13b6f99986b3b1))
-
-* Add openssf scorecard badge
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`20040d6`](https://github.com/sandialabs/sansmic/commit/20040d6cd98a63bed9049540a235f89a7de823d2))
-
 * Create scorecard.yml
-
-Add in security scorecard scanning
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`212f5f3`](https://github.com/sandialabs/sansmic/commit/212f5f34985d406284d8d92472914dffaf3e7e6a))
-
 * Adding OpenSSF badge
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`4236b9d`](https://github.com/sandialabs/sansmic/commit/4236b9d8ce1543c0c8d9ea5e41ff07b46e07da6e))
-
-* Documentation updates ([`a461b58`](https://github.com/sandialabs/sansmic/commit/a461b58256042d6e69ed5d6a5597fa89c103472f))
-
-* Fix the readme documentation ([`73c179a`](https://github.com/sandialabs/sansmic/commit/73c179a69e01f4392786f2b8832e936ee775dc88))
-
-* Updates to the app and the model classes ([`35619ea`](https://github.com/sandialabs/sansmic/commit/35619eaa59bb4d2688fd534b188872d9f68581a9))
-
-* published ghost-test wheel to pypi ([`e58e129`](https://github.com/sandialabs/sansmic/commit/e58e129ee3984d9a3d4f1ab8a03e78b9ae9aaab8))
-
-* Initial python classes import and attempt at pypi test ([`d8e8401`](https://github.com/sandialabs/sansmic/commit/d8e8401719f9f24dbc527018bdd1a4985005c458))
-
-* Committing the setup and configuration files. ([`560c6bd`](https://github.com/sandialabs/sansmic/commit/560c6bd158049404a6a271171447f0f9b83e9b0f))
-
-* Update README.md
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`d8ecb09`](https://github.com/sandialabs/sansmic/commit/d8ecb09a007b39bd3f7cef4a71738b250b9fa38c))
-
-* Update README.md
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`d1324fe`](https://github.com/sandialabs/sansmic/commit/d1324feb077dbaf5d77450bfa6976cb91178d90f))
-
-* Update README.md
-
-Fix broken hyperlinks
-
-Signed-off-by: David Hart &lt;[email protected]&gt; ([`4a5613c`](https://github.com/sandialabs/sansmic/commit/4a5613cf949f7930d1794b029afc2c20e6f01ec3))
-
-* Update to base documentation ([`5db6234`](https://github.com/sandialabs/sansmic/commit/5db6234b3d9e5623b41b345d3d4945b530e908c9))
-
 * Initial commit ([`4cf7cf7`](https://github.com/sandialabs/sansmic/commit/4cf7cf73416b10de77640b189e61fced932f15e0))
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ name = "sansmic"
 description = "Sandia solution mining modeling software"
 readme = "README.md"
 requires-python = ">=3.9"
-version = "1.0.0"
+version = "1.0.1"
 authors = [
     { name = "National Technology & Engineering Solutions of Sandia, LLC (NTESS)" },
     { name = "SANSMIC Authors (see AUTHORS.md)" },
@@ -77,7 +77,7 @@ sansmic = "src/python/sansmic"
 [tool.semantic_release]
 assets = []
 build_command_env = []
-commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
+commit_message = "release: {version}\n\nAutomatically generated by python-semantic-release"
 commit_parser = "angular"
 logging_use_named_masks = false
 major_on_zero = true
@@ -101,7 +101,7 @@ prerelease = false
 [tool.semantic_release.changelog]
 template_dir = "templates"
 changelog_file = "CHANGELOG.md"
-exclude_commit_patterns = ["build", "ci", "chore", "style"]
+exclude_commit_patterns = ["build", "ci", "chore", "style", "docs", "^Bump", "release"]
 
 [tool.semantic_release.changelog.environment]
 block_start_string = "{%"
@@ -136,6 +136,9 @@ allowed_tags = [
     "refactor", # A change that does not add a feature nor fix a bug (could be major, minor or patch)
     "docs",     # Documentation-only changes within the source code (no version level change)
     "style",    # A code that does not change meaning of the code (no version level change)
+    # Release
+    "release"
+
 ]
 minor_tags = ["feat"]
 patch_tags = ["fix", "perf", "refactor"]

diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 from setuptools import find_packages, setup
 from pybind11.setup_helpers import Pybind11Extension, build_ext
 
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 
 here = path.abspath(path.dirname(__file__))
 

diff --git a/src/python/sansmic/__init__.py b/src/python/sansmic/__init__.py
@@ -7,7 +7,7 @@
 # SPDX-License-Identifier: BSD-3-Clause.
 
 """SANSMIC package"""
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 __copyright__ = f"""Copyright (c) 2024 National Technology and Engineering Solutions of Sandia,
 LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
 Government retains certain rights in this software."""