diff --git a/.github/workflows/edgetest.yml b/.github/workflows/edgetest.yml index 13f0d1c..4f15cc6 100644 --- a/.github/workflows/edgetest.yml +++ b/.github/workflows/edgetest.yml @@ -16,7 +16,7 @@ jobs: steps: - uses: actions/checkout@v4 with: - ref: develop + ref: main - name: Copy files for locopy id: copy-files run: | @@ -26,6 +26,6 @@ jobs: uses: edgetest-dev/run-edgetest-action@v1.6 with: edgetest-flags: '-c pyproject.toml --export' - base-branch: 'develop' + base-branch: 'main' skip-pr: 'false' add-paths: 'pyproject.toml, requirements.txt' diff --git a/docs/source/developer.rst b/docs/source/developer.rst index 44341eb..6e12702 100644 --- a/docs/source/developer.rst +++ b/docs/source/developer.rst @@ -10,7 +10,7 @@ We use the excellent `pre-commit `_ to run several hook ``pre-commit`` is included in the ``dev`` extra installs. You'll have to run ``pre-commit install`` once per environment before committing changes. -The reason behind running black, isort, and others as a pre-commit hook is to let a machine make style decisions, based +The reason behind running ruff and others as a pre-commit hook is to let a machine make style decisions, based on the collective wisdom of the Python community. Generating Documentation @@ -125,23 +125,26 @@ This should return output like the following and also update our ``dependencies` Release Guide ------------- -For ``locopy`` we use a simple workflow branching style and follow -`Semantic Versioning `_ for each release. +Starting in 2026 we've modified our git workflow. -``develop`` is the default branch where most people will work with day to day. All features must be squash merged into -this branch. The reason we squash merge is to prevent the develop branch from being polluted with endless commit messages -when people are developing. Squashing collapses all the commits into one single new commit. It will also make it much easier to -back out changes if something breaks. +``main`` will be the core branch where all features will get merged into and +production ready code will also exist. When a release is ready to be made releases/tags will be use +to point to the commit where the release should be made from. -``main`` is where official releases will go. Each release on ``main`` should be tagged properly to denote a "version" -that will have the corresponding artifact on pypi for users to ``pip install``. +In the past we had used ``dev``, in conjunction with ``main``, but there were some issues +with diverging branches and new rulesets which make the ``main`` only branching strategy +easier to manage. -``gh-pages`` is where official documentation will go. After each release you should build the docs and push the HTML to -the pages branch. When first setting up the repo you want to make sure your gh-pages is a orphaned branch since it is +Each release on ``main`` should be tagged properly to denote a "version" that will have the +corresponding artifact on PyPI for users to ``pip install``. + + +``gh-pages`` is where official documentation will go. After each release you should +build the docs and push the HTML to the pages branch. When first setting up the +repo you want to make sure your gh-pages is a orphaned branch since it is disconnected and independent from the code: ``git checkout --orphan gh-pages``. -The repo has a ``Makefile`` in the root folder which has helper commands such as ``make sphinx``, and -``make ghpages`` to help streamline building and pushing docs once they are setup right. +To build the documentation, run ``make sphinx``. To push, run ``make ghpages``. diff --git a/locopy/_version.py b/locopy/_version.py index f7a23f3..0e65f4b 100644 --- a/locopy/_version.py +++ b/locopy/_version.py @@ -14,4 +14,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "0.6.7" +__version__ = "0.6.8" diff --git a/pyproject.toml b/pyproject.toml index eef735e..3c8f5bd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ authors = [ { name="Faisal Dosani", email="faisal.dosani@capitalone.com" }, ] license = {text = "Apache Software License"} -dependencies = ["boto3<=1.42.33,>=1.9.92", "PyYAML<=6.0.2,>=5.1", "pandas<=2.3.3,>=1.5.0", "numpy<=2.2.6,>=1.22.0", "polars>=0.20.0", "pyarrow>=10.0.1"] +dependencies = ["boto3<=1.42.34,>=1.9.92", "PyYAML<=6.0.2,>=5.1", "pandas<=2.3.3,>=1.5.0", "numpy<=2.2.6,>=1.22.0", "polars>=0.20.0", "pyarrow>=10.0.1"] requires-python = ">=3.9.0" classifiers = [ @@ -123,4 +123,4 @@ upgrade = [ [tool.pytest.ini_options] markers = [ "integration", -] \ No newline at end of file +] diff --git a/requirements.txt b/requirements.txt index 70287cc..61cd46f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,8 @@ # This file was autogenerated by uv via the following command: # uv pip compile --output-file=requirements.txt pyproject.toml -boto3==1.42.33 +boto3==1.42.34 # via locopy (pyproject.toml) -botocore==1.42.33 +botocore==1.42.34 # via # boto3 # s3transfer