diff --git a/.github/workflows/check_black.yml b/.github/workflows/check_format.yml similarity index 57% rename from .github/workflows/check_black.yml rename to .github/workflows/check_format.yml index ca27c0693..1176d48c7 100644 --- a/.github/workflows/check_black.yml +++ b/.github/workflows/check_format.yml @@ -1,5 +1,5 @@ -name: Check Black formatting +name: Check code formatting on: [push, pull_request] @@ -7,9 +7,9 @@ jobs: lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-python@v2 + - uses: actions/checkout@v4 + - uses: actions/setup-python@v4 - uses: psf/black@stable with: options: "-l 79 --check" - src: "." \ No newline at end of file + src: "." diff --git a/README.md b/README.md index d001a34bb..e506ec173 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ | --- | --- | | Org | [![PSL cataloged](https://img.shields.io/badge/PSL-cataloged-a0a0a0.svg)](https://www.PSLmodels.org) [![OS License: CCO-1.0](https://img.shields.io/badge/OS%20License-CCO%201.0-yellow)](https://github.com/PSLmodels/OG-Core/blob/master/LICENSE) [![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://pslmodels.github.io/OG-Core/) | | Package | [![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3108/) [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3118/) [![PyPI Latest Release](https://img.shields.io/pypi/v/ogcore.svg)](https://pypi.org/project/ogcore/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogcore.svg?label=PyPI%20downloads)](https://pypi.org/project/ogcore/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) | -| Testing | ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/build_and_test.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/deploy_docs.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/check_black.yml/badge.svg?branch=master) [![Codecov](https://codecov.io/gh/PSLmodels/OG-Core/branch/master/graph/badge.svg)](https://codecov.io/gh/PSLmodels/OG-Core) | +| Testing | ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/build_and_test.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/deploy_docs.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-Core/actions/workflows/check_format.yml/badge.svg?branch=master) [![Codecov](https://codecov.io/gh/PSLmodels/OG-Core/branch/master/graph/badge.svg)](https://codecov.io/gh/PSLmodels/OG-Core) | OG-Core is an overlapping-generations (OG) model core theory, logic, and solution method algorithms that allow for dynamic general equilibrium analysis of fiscal policy. OG-Core provides a general framework and is a dependency of several country-specific OG models, such as [OG-USA](https://github.com/PSLmodels/OG-USA) and [OG-UK](https://github.com/PSLmodels/OG-UK). The model output includes changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Regularly updated documentation of the model theory--its output, and solution method--and the Python API is available [here](https://pslmodels.github.io/OG-Core). diff --git a/changelog_entry.yaml b/changelog_entry.yaml index ea1c6fe1d..91716a94f 100644 --- a/changelog_entry.yaml +++ b/changelog_entry.yaml @@ -1,5 +1,12 @@ - bump: patch changes: added: - - Adds automatic versioning workflow by updating `build_and_test.yml`, adding ` - - Updates `README.md` + - Adds the following files for automatic versioning, `.github/changelog_template.md`, `.github/get-changelog-diff.sh`, `.github/has-functional-changes.sh`, `.github/is-version-number-acceptable.sh` + - Adds "Check version" job to `build_and_test.yml` GH Action. + - Adds `tag_version.yml` GH Action on push to master branch. + - Adds three new functions to `Makefile` + - Adds starting `changelog.yaml`. + - Updates `contributor_guide.md`. + - Updates `README.md`. + - Renamed code formatting GH Action from `check_black.yml` to `check_format.yml` and updated the actions within. + - Removes hard reference to version number in `./ogcore/__init__.py` so that the version reference automatically updates.